Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 19908edcd8a3df1db41e34100acc1f15c3c99397 / . / docs / dyn / bigqueryreservation_v1beta1.projects.locations.reservations.html
blob: 3832b9b32b4da9a363f18ff9d53e874fe0ad9667 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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="bigqueryreservation_v1beta1.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1beta1.projects.html">projects</a> . <a href="bigqueryreservation_v1beta1.projects.locations.html">locations</a> . <a href="bigqueryreservation_v1beta1.projects.locations.reservations.html">reservations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html">assignments()</a></code>
79</p>
80<p class="firstline">Returns the assignments 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.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes a reservation.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Returns information about the reservation.</p>
91<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]92 <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]93<p class="firstline">Lists all the reservations for the project in the specified location.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
98 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
99<p class="firstline">Updates an existing reservation resource.</p>
100<h3>Method Details</h3>
101<div class="method">
102 <code class="details" id="create">create(parent, body=None, reservationId=None, x__xgafv=None)</code>
103 <pre>Creates a new reservation resource.
104
105Args:
106 parent: string, Required. Project, location. E.g.,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]107`projects/myproject/locations/US` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 body: object, The request body.
109 The object takes the form of:
110
111{ # A reservation is a mechanism used to guarantee slots to users.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]112 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
113 # `projects/*/locations/*/reservations/team1-prod`.
114 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
115 # reservations within the same admin project. If true, a query using this
116 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
118 # computational power in BigQuery, and serves as the unit of parallelism.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]119 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 # Queries using this reservation might use more slots during runtime if
121 # ignore_idle_slots is set to false.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]122 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
124 # if total slot capacity of the new reservation and its siblings exceeds the
125 # parent&#x27;s slot capacity, the request will fail with
126 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127}
128
129 reservationId: string, The reservation ID. This field must only contain lower case alphanumeric
130characters or dash. Max length is 64 characters.
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 reservation is a mechanism used to guarantee slots to users.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]140 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
141 # `projects/*/locations/*/reservations/team1-prod`.
142 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
143 # reservations within the same admin project. If true, a query using this
144 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
146 # computational power in BigQuery, and serves as the unit of parallelism.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]147 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]148 # Queries using this reservation might use more slots during runtime if
149 # ignore_idle_slots is set to false.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]150 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
152 # if total slot capacity of the new reservation and its siblings exceeds the
153 # parent&#x27;s slot capacity, the request will fail with
154 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
160 <pre>Deletes a reservation.
161Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has
162assignments.
163
164Args:
165 name: string, Required. Resource name of the reservation to retrieve. E.g.,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]166 `projects/myproject/locations/US/reservations/team1-prod` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
171
172Returns:
173 An object of the form:
174
175 { # A generic empty message that you can re-use to avoid defining duplicated
176 # empty messages in your APIs. A typical example is to use it as the request
177 # or the response type of an API method. For instance:
178 #
179 # service Foo {
180 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
181 # }
182 #
183 # The JSON representation for `Empty` is empty JSON object `{}`.
184 }</pre>
185</div>
186
187<div class="method">
188 <code class="details" id="get">get(name, x__xgafv=None)</code>
189 <pre>Returns information about the reservation.
190
191Args:
192 name: string, Required. Resource name of the reservation to retrieve. E.g.,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]193 `projects/myproject/locations/US/reservations/team1-prod` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199Returns:
200 An object of the form:
201
202 { # A reservation is a mechanism used to guarantee slots to users.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]203 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
204 # `projects/*/locations/*/reservations/team1-prod`.
205 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
206 # reservations within the same admin project. If true, a query using this
207 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
209 # computational power in BigQuery, and serves as the unit of parallelism.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]210 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 # Queries using this reservation might use more slots during runtime if
212 # ignore_idle_slots is set to false.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]213 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
215 # if total slot capacity of the new reservation and its siblings exceeds the
216 # parent&#x27;s slot capacity, the request will fail with
217 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]218 }</pre>
219</div>
220
221<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]222 <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]223 <pre>Lists all the reservations for the project in the specified location.
224
225Args:
226 parent: string, Required. The parent resource name containing project and location, e.g.:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]227 `projects/myproject/locations/US` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]228 filter: string, Can be used to filter out reservations based on names, capacity, etc, e.g.:
229filter=&quot;reservation.slot_capacity &gt; 200&quot;
230filter=&quot;reservation.name = \&quot;*dev/*\&quot;&quot;
231Advanced filtering syntax can be
232[here](https://cloud.google.com/logging/docs/view/advanced-filters).
233 pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]234 pageSize: integer, The maximum number of items to return.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
239
240Returns:
241 An object of the form:
242
243 { # The response for ReservationService.ListReservations.
244 &quot;reservations&quot;: [ # List of reservations visible to the user.
245 { # A reservation is a mechanism used to guarantee slots to users.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]246 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
247 # `projects/*/locations/*/reservations/team1-prod`.
248 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
249 # reservations within the same admin project. If true, a query using this
250 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]251 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
252 # computational power in BigQuery, and serves as the unit of parallelism.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]253 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]254 # Queries using this reservation might use more slots during runtime if
255 # ignore_idle_slots is set to false.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]256 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]257 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
258 # if total slot capacity of the new reservation and its siblings exceeds the
259 # parent&#x27;s slot capacity, the request will fail with
260 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]261 },
262 ],
263 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
264 # more results in the list.
265 }</pre>
266</div>
267
268<div class="method">
269 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
270 <pre>Retrieves the next page of results.
271
272Args:
273 previous_request: The request for the previous page. (required)
274 previous_response: The response from the request for the previous page. (required)
275
276Returns:
277 A request object that you can call &#x27;execute()&#x27; on to request the next
278 page. Returns None if there are no more items in the collection.
279 </pre>
280</div>
281
282<div class="method">
283 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
284 <pre>Updates an existing reservation resource.
285
286Args:
287 name: string, The resource name of the reservation, e.g.,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]288`projects/*/locations/*/reservations/team1-prod`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 body: object, The request body.
290 The object takes the form of:
291
292{ # A reservation is a mechanism used to guarantee slots to users.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]293 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
294 # `projects/*/locations/*/reservations/team1-prod`.
295 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
296 # reservations within the same admin project. If true, a query using this
297 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]298 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
299 # computational power in BigQuery, and serves as the unit of parallelism.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]300 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]301 # Queries using this reservation might use more slots during runtime if
302 # ignore_idle_slots is set to false.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]303 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]308}
309
310 updateMask: string, Standard field mask for the set of fields to be updated.
311 x__xgafv: string, V1 error format.
312 Allowed values
313 1 - v1 error format
314 2 - v2 error format
315
316Returns:
317 An object of the form:
318
319 { # A reservation is a mechanism used to guarantee slots to users.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]320 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
321 # `projects/*/locations/*/reservations/team1-prod`.
322 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
323 # reservations within the same admin project. If true, a query using this
324 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]325 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
326 # computational power in BigQuery, and serves as the unit of parallelism.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]327 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]328 # Queries using this reservation might use more slots during runtime if
329 # ignore_idle_slots is set to false.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]330 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]331 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
332 # if total slot capacity of the new reservation and its siblings exceeds the
333 # parent&#x27;s slot capacity, the request will fail with
334 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]335 }</pre>
336</div>
337
338</body></html>