blob: 18c2ef55f3bd78d0a475e33d8ba18a9079df0a25 [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_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> . <a href="bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html">assignments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a assignment. No expansion will happen.</p>
83<p class="toc_element">
84 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Lists assignments.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90 <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Moves a assignment under a new reservation. Customers can do this by</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
95 <pre>Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have
96&#x27;bigquery.admin&#x27; permissions on the project using the reservation
97and the project that owns this reservation.
98Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment
99does not match location of the reservation.
100
101Args:
102 parent: string, Required. The parent resource name of the assignment
103E.g.: projects/myproject/locations/US/reservations/team1-prod (required)
104 body: object, The request body.
105 The object takes the form of:
106
107{ # A Assignment allows a project to submit jobs
108 # of a certain type using slots from the specified reservation.
109 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
110 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
111 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.:
112 # projects/myproject/locations/US/reservations/team1-prod/assignments/123.
113 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g.
114 # projects/myproject, folders/123, organizations/456.
115}
116
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121
122Returns:
123 An object of the form:
124
125 { # A Assignment allows a project to submit jobs
126 # of a certain type using slots from the specified reservation.
127 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
128 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
129 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.:
130 # projects/myproject/locations/US/reservations/team1-prod/assignments/123.
131 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g.
132 # projects/myproject, folders/123, organizations/456.
133 }</pre>
134</div>
135
136<div class="method">
137 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
138 <pre>Deletes a assignment. No expansion will happen.
139E.g:
140organizationA contains project1 and project2. Reservation res1 exists.
141CreateAssignment was invoked previously and following assignments were
142created explicitly:
143 &lt;organizationA, res1&gt;
144 &lt;project1, res1&gt;
145Then deletion of &lt;organizationA, res1&gt; won&#x27;t affect &lt;project1, res1&gt;. After
146deletion of &lt;organizationA, res1&gt;, queries from project1 will still use
147res1, while queries from project2 will use on-demand mode.
148
149Args:
150 name: string, Required. Name of the resource, e.g.:
151 projects/myproject/locations/US/reservations/team1-prod/assignments/123 (required)
152 x__xgafv: string, V1 error format.
153 Allowed values
154 1 - v1 error format
155 2 - v2 error format
156
157Returns:
158 An object of the form:
159
160 { # A generic empty message that you can re-use to avoid defining duplicated
161 # empty messages in your APIs. A typical example is to use it as the request
162 # or the response type of an API method. For instance:
163 #
164 # service Foo {
165 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
166 # }
167 #
168 # The JSON representation for `Empty` is empty JSON object `{}`.
169 }</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
174 <pre>Lists assignments.
175Only explicitly created assignments will be returned. E.g:
176organizationA contains project1 and project2. Reservation res1 exists.
177CreateAssignment was invoked previously and following assignments were
178created explicitly:
179 &lt;organizationA, res1&gt;
180 &lt;project1, res1&gt;
181Then this API will just return the above two assignments for reservation
182res1, and no expansion/merge will happen. Wildcard &quot;-&quot; can be used for
183reservations in the request. In that case all assignments belongs to the
184specified project and location will be listed. Note
185&quot;-&quot; cannot be used for projects nor locations.
186
187Args:
188 parent: string, Required. The parent resource name e.g.:
189projects/myproject/locations/US/reservations/team1-prod
190Or:
191projects/myproject/locations/US/reservations/- (required)
192 pageToken: string, The next_page_token value returned from a previous List request, if any.
193 pageSize: integer, The maximum number of items to return.
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 { # The response for ReservationService.ListAssignments.
203 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
204 # more results in the list.
205 &quot;assignments&quot;: [ # List of assignments visible to the user.
206 { # A Assignment allows a project to submit jobs
207 # of a certain type using slots from the specified reservation.
208 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
209 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
210 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.:
211 # projects/myproject/locations/US/reservations/team1-prod/assignments/123.
212 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g.
213 # projects/myproject, folders/123, organizations/456.
214 },
215 ],
216 }</pre>
217</div>
218
219<div class="method">
220 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
221 <pre>Retrieves the next page of results.
222
223Args:
224 previous_request: The request for the previous page. (required)
225 previous_response: The response from the request for the previous page. (required)
226
227Returns:
228 A request object that you can call &#x27;execute()&#x27; on to request the next
229 page. Returns None if there are no more items in the collection.
230 </pre>
231</div>
232
233<div class="method">
234 <code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
235 <pre>Moves a assignment under a new reservation. Customers can do this by
236deleting the existing assignment followed by creating another assignment
237under the new reservation, but this method provides a transactional way to
238do so, to make sure the assignee always has an associated reservation.
239Without the method customers might see some queries run on-demand which
240might be unexpected.
241
242Args:
243 name: string, Required. The resource name of the assignment,
244e.g.:
245 projects/myproject/locations/US/reservations/team1-prod/assignments/123 (required)
246 body: object, The request body.
247 The object takes the form of:
248
249{ # The request for
250 # ReservationService.MoveAssignment.
251 # Note: &quot;bigquery.reservationAssignments.create&quot; permission is required on the
252 # destination_id. Note: &quot;bigquery.reservationAssignments.create&quot; and
253 # &quot;bigquery.reservationAssignments.delete&quot; permission is required on the
254 # related assignee.
255 &quot;destinationId&quot;: &quot;A String&quot;, # The new reservation ID, e.g.:
256 # projects/myotherproject/locations/US/reservations/team2-prod
257 }
258
259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
263
264Returns:
265 An object of the form:
266
267 { # A Assignment allows a project to submit jobs
268 # of a certain type using slots from the specified reservation.
269 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
270 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
271 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.:
272 # projects/myproject/locations/US/reservations/team1-prod/assignments/123.
273 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g.
274 # projects/myproject, folders/123, organizations/456.
275 }</pre>
276</div>
277
278</body></html>