blob: e19099908759e98254d4a71812c3352e865bfdc1 [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_v1.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1.projects.html">projects</a> . <a href="bigqueryreservation_v1.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="bigqueryreservation_v1.projects.locations.capacityCommitments.html">capacityCommitments()</a></code>
79</p>
80<p class="firstline">Returns the capacityCommitments Resource.</p>
81
82<p class="toc_element">
83 <code><a href="bigqueryreservation_v1.projects.locations.reservations.html">reservations()</a></code>
84</p>
85<p class="firstline">Returns the reservations Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#getBiReservation">getBiReservation(name, x__xgafv=None)</a></code></p>
89<p class="firstline">Retrieves a BI reservation.</p>
90<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070091 <code><a href="#searchAssignments">searchAssignments(parent, query=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070092<p class="firstline">Looks up assignments for a specified resource for a particular region.</p>
93<p class="toc_element">
94 <code><a href="#searchAssignments_next">searchAssignments_next(previous_request, previous_response)</a></code></p>
95<p class="firstline">Retrieves the next page of results.</p>
96<p class="toc_element">
97 <code><a href="#updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
98<p class="firstline">Updates a BI reservation.</p>
99<h3>Method Details</h3>
100<div class="method">
101 <code class="details" id="getBiReservation">getBiReservation(name, x__xgafv=None)</code>
102 <pre>Retrieves a BI reservation.
103
104Args:
105 name: string, Required. Name of the requested reservation, for example:
106`projects/{project_id}/locations/{location_id}/bireservation` (required)
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
111
112Returns:
113 An object of the form:
114
115 { # Represents a BI Reservation.
116 &quot;size&quot;: &quot;A String&quot;, # Size of a reservation, in bytes.
117 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of a reservation.
118 &quot;name&quot;: &quot;A String&quot;, # The resource name of the singleton BI reservation.
119 # Reservation names have the form
120 # `projects/{project_id}/locations/{location_id}/bireservation`.
121 }</pre>
122</div>
123
124<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700125 <code class="details" id="searchAssignments">searchAssignments(parent, query=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700126 <pre>Looks up assignments for a specified resource for a particular region.
127If the request is about a project:
128
1291. Assignments created on the project will be returned if they exist.
1302. Otherwise assignments created on the closest ancestor will be
131 returned.
1323. Assignments for different JobTypes will all be returned.
133
134The same logic applies if the request is about a folder.
135
136If the request is about an organization, then assignments created on the
137organization will be returned (organization doesn&#x27;t have ancestors).
138
139Comparing to ListAssignments, there are some behavior
140differences:
141
1421. permission on the assignee will be verified in this API.
1432. Hierarchy lookup (project-&gt;folder-&gt;organization) happens in this API.
1443. Parent here is `projects/*/locations/*`, instead of
145 `projects/*/locations/*reservations/*`.
146
147**Note** &quot;-&quot; cannot be used for projects
148nor locations.
149
150Args:
151 parent: string, Required. The resource name of the admin project(containing project and location),
152e.g.:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700153 `projects/myproject/locations/US`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 query: string, Please specify resource name as assignee in the query.
155
156Examples:
157
158* `assignee=projects/myproject`
159* `assignee=folders/123`
160* `assignee=organizations/456`
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700161 pageToken: string, The next_page_token value returned from a previous List request, if any.
162 pageSize: integer, The maximum number of items to return per page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168Returns:
169 An object of the form:
170
171 { # The response for ReservationService.SearchAssignments.
Bu Sun Kim65020912020-05-20 12:08:20 -0700172 &quot;assignments&quot;: [ # List of assignments visible to the user.
173 { # A Assignment allows a project to submit jobs
174 # of a certain type using slots from the specified reservation.
175 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
176 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
177 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.:
178 # `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
179 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g.
180 # `projects/myproject`, `folders/123`, or `organizations/456`.
181 },
182 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700183 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
184 # more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="searchAssignments_next">searchAssignments_next(previous_request, previous_response)</code>
190 <pre>Retrieves the next page of results.
191
192Args:
193 previous_request: The request for the previous page. (required)
194 previous_response: The response from the request for the previous page. (required)
195
196Returns:
197 A request object that you can call &#x27;execute()&#x27; on to request the next
198 page. Returns None if there are no more items in the collection.
199 </pre>
200</div>
201
202<div class="method">
203 <code class="details" id="updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</code>
204 <pre>Updates a BI reservation.
205
206Only fields specified in the `field_mask` are updated.
207
208A singleton BI reservation always exists with default size 0.
209In order to reserve BI capacity it needs to be updated to an amount
210greater than 0. In order to release BI capacity reservation size
211must be set to 0.
212
213Args:
214 name: string, The resource name of the singleton BI reservation.
215Reservation names have the form
216`projects/{project_id}/locations/{location_id}/bireservation`. (required)
217 body: object, The request body.
218 The object takes the form of:
219
220{ # Represents a BI Reservation.
221 &quot;size&quot;: &quot;A String&quot;, # Size of a reservation, in bytes.
222 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of a reservation.
223 &quot;name&quot;: &quot;A String&quot;, # The resource name of the singleton BI reservation.
224 # Reservation names have the form
225 # `projects/{project_id}/locations/{location_id}/bireservation`.
226}
227
228 updateMask: string, A list of fields to be updated in this request.
229 x__xgafv: string, V1 error format.
230 Allowed values
231 1 - v1 error format
232 2 - v2 error format
233
234Returns:
235 An object of the form:
236
237 { # Represents a BI Reservation.
238 &quot;size&quot;: &quot;A String&quot;, # Size of a reservation, in bytes.
239 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of a reservation.
240 &quot;name&quot;: &quot;A String&quot;, # The resource name of the singleton BI reservation.
241 # Reservation names have the form
242 # `projects/{project_id}/locations/{location_id}/bireservation`.
243 }</pre>
244</div>
245
246</body></html>