Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ed7d3f9b61ac35e08a22b4995076a95451cf7c8 / . / docs / dyn / bigqueryreservation_v1.projects.locations.reservations.html
blob: a5519b9d27eff43649fd073531c1f2c03587f225 [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_v1.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1.projects.html">projects</a> . <a href="bigqueryreservation_v1.projects.locations.html">locations</a> . <a href="bigqueryreservation_v1.projects.locations.reservations.html">reservations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="bigqueryreservation_v1.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">
92 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
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.,
107`projects/myproject/locations/US` (required)
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
113 # computational power in BigQuery, and serves as the unit of parallelism.
114 #
115 # Queries using this reservation might use more slots during runtime if
116 # ignore_idle_slots is set to false.
117 #
118 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
119 # if total slot capacity of the new reservation and its siblings exceeds the
120 # parent&#x27;s slot capacity, the request will fail with
121 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]122 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
123 # `projects/*/locations/*/reservations/team1-prod`.
124 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
125 # reservations within the same admin project. If true, a query using this
126 # reservation will execute with the slot capacity specified above at most.
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
141 # computational power in BigQuery, and serves as the unit of parallelism.
142 #
143 # Queries using this reservation might use more slots during runtime if
144 # ignore_idle_slots is set to false.
145 #
146 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
147 # if total slot capacity of the new reservation and its siblings exceeds the
148 # parent&#x27;s slot capacity, the request will fail with
149 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]150 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
151 # `projects/*/locations/*/reservations/team1-prod`.
152 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
153 # reservations within the same admin project. If true, a query using this
154 # reservation will execute with the slot capacity specified above at most.
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.,
166 `projects/myproject/locations/US/reservations/team1-prod` (required)
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.,
193 `projects/myproject/locations/US/reservations/team1-prod` (required)
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
204 # computational power in BigQuery, and serves as the unit of parallelism.
205 #
206 # Queries using this reservation might use more slots during runtime if
207 # ignore_idle_slots is set to false.
208 #
209 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
210 # if total slot capacity of the new reservation and its siblings exceeds the
211 # parent&#x27;s slot capacity, the request will fail with
212 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]213 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
214 # `projects/*/locations/*/reservations/team1-prod`.
215 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
216 # reservations within the same admin project. If true, a query using this
217 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]218 }</pre>
219</div>
220
221<div class="method">
222 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
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 pageToken: string, The next_page_token value returned from a previous List request, if any.
229 pageSize: integer, The maximum number of items to return per page.
230 x__xgafv: string, V1 error format.
231 Allowed values
232 1 - v1 error format
233 2 - v2 error format
234
235Returns:
236 An object of the form:
237
238 { # The response for ReservationService.ListReservations.
239 &quot;reservations&quot;: [ # List of reservations visible to the user.
240 { # A reservation is a mechanism used to guarantee slots to users.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
242 # computational power in BigQuery, and serves as the unit of parallelism.
243 #
244 # Queries using this reservation might use more slots during runtime if
245 # ignore_idle_slots is set to false.
246 #
247 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
248 # if total slot capacity of the new reservation and its siblings exceeds the
249 # parent&#x27;s slot capacity, the request will fail with
250 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]251 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
252 # `projects/*/locations/*/reservations/team1-prod`.
253 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
254 # reservations within the same admin project. If true, a query using this
255 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]256 },
257 ],
258 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
259 # more results in the list.
260 }</pre>
261</div>
262
263<div class="method">
264 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
265 <pre>Retrieves the next page of results.
266
267Args:
268 previous_request: The request for the previous page. (required)
269 previous_response: The response from the request for the previous page. (required)
270
271Returns:
272 A request object that you can call &#x27;execute()&#x27; on to request the next
273 page. Returns None if there are no more items in the collection.
274 </pre>
275</div>
276
277<div class="method">
278 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
279 <pre>Updates an existing reservation resource.
280
281Args:
282 name: string, The resource name of the reservation, e.g.,
283`projects/*/locations/*/reservations/team1-prod`. (required)
284 body: object, The request body.
285 The object takes the form of:
286
287{ # A reservation is a mechanism used to guarantee slots to users.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]288 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
289 # computational power in BigQuery, and serves as the unit of parallelism.
290 #
291 # Queries using this reservation might use more slots during runtime if
292 # ignore_idle_slots is set to false.
293 #
294 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
295 # if total slot capacity of the new reservation and its siblings exceeds the
296 # parent&#x27;s slot capacity, the request will fail with
297 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]298 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
299 # `projects/*/locations/*/reservations/team1-prod`.
300 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
301 # reservations within the same admin project. If true, a query using this
302 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]303}
304
305 updateMask: string, Standard field mask for the set of fields to be updated.
306 x__xgafv: string, V1 error format.
307 Allowed values
308 1 - v1 error format
309 2 - v2 error format
310
311Returns:
312 An object of the form:
313
314 { # A reservation is a mechanism used to guarantee slots to users.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]315 &quot;slotCapacity&quot;: &quot;A String&quot;, # Minimum slots available to this reservation. A slot is a unit of
316 # computational power in BigQuery, and serves as the unit of parallelism.
317 #
318 # Queries using this reservation might use more slots during runtime if
319 # ignore_idle_slots is set to false.
320 #
321 # If the new reservation&#x27;s slot capacity exceed the parent&#x27;s slot capacity or
322 # if total slot capacity of the new reservation and its siblings exceeds the
323 # parent&#x27;s slot capacity, the request will fail with
324 # `google.rpc.Code.RESOURCE_EXHAUSTED`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]325 &quot;name&quot;: &quot;A String&quot;, # The resource name of the reservation, e.g.,
326 # `projects/*/locations/*/reservations/team1-prod`.
327 &quot;ignoreIdleSlots&quot;: True or False, # If false, any query using this reservation will use idle slots from other
328 # reservations within the same admin project. If true, a query using this
329 # reservation will execute with the slot capacity specified above at most.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]330 }</pre>
331</div>
332
333</body></html>