Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f0c2fa653712b63bb121d6b59a0de8c7103480e4 / . / docs / dyn / bigqueryreservation_v1.projects.locations.reservations.assignments.html
blob: bf021ed8164e58f97d63eac3a16529ba19f03ee7 [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> . <a href="bigqueryreservation_v1.projects.locations.reservations.assignments.html">assignments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame^]81 <code><a href="#create">create(parent, assignmentId=None, body=None, x__xgafv=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]82<p class="firstline">Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. "None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: `projects/myproject/locations/US/reservations/none`. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes a assignment. No expansion will happen. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, deletion of the `` assignment won't affect the other assignment ``. After said deletion, queries from `project1` will still use `res1` while queries from `project2` will switch to use on-demand mode.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, ListAssignments will just return the above two assignments for reservation `res1`, and no expansion/merge will happen. The wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. **Note** "-" cannot be used for projects nor locations.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94<p class="firstline">Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.</p>
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame^]95<p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates an existing assignment. Only the `priority` field can be updated.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame^]105 <code class="details" id="create">create(parent, assignmentId=None, body=None, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]106 <pre>Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. &quot;None&quot; assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a &quot;None&quot; assignment, use &quot;none&quot; as a reservation_id in the parent. Example parent: `projects/myproject/locations/US/reservations/none`. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have &#x27;bigquery.admin&#x27; permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107
108Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 parent: string, Required. The parent resource name of the assignment E.g. `projects/myproject/locations/US/reservations/team1-prod` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 body: object, The request body.
111 The object takes the form of:
112
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]113{ # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]114 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]115 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]116 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]117 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118}
119
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame^]120 assignmentId: string, The optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126Returns:
127 An object of the form:
128
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129 { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]130 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
131 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
132 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
133 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
134}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135</div>
136
137<div class="method">
138 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]139 <pre>Deletes a assignment. No expansion will happen. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, deletion of the `` assignment won&#x27;t affect the other assignment ``. After said deletion, queries from `project1` will still use `res1` while queries from `project2` will switch to use on-demand mode.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140
141Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142 name: string, Required. Name of the resource, e.g. `projects/myproject/locations/US/reservations/team1-prod/assignments/123` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
147
148Returns:
149 An object of the form:
150
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]151 { # 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 `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]152}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153</div>
154
155<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]156 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]157 <pre>Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, ListAssignments will just return the above two assignments for reservation `res1`, and no expansion/merge will happen. The wildcard &quot;-&quot; can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. **Note** &quot;-&quot; cannot be used for projects nor locations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158
159Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]160 parent: string, Required. The parent resource name e.g.: `projects/myproject/locations/US/reservations/team1-prod` Or: `projects/myproject/locations/US/reservations/-` (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]161 pageSize: integer, The maximum number of items to return per page.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]162 pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 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.ListAssignments.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]172 &quot;assignments&quot;: [ # List of assignments visible to the user.
173 { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
174 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
175 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
176 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
177 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
178 },
179 ],
180 &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.
181}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182</div>
183
184<div class="method">
185 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
186 <pre>Retrieves the next page of results.
187
188Args:
189 previous_request: The request for the previous page. (required)
190 previous_response: The response from the request for the previous page. (required)
191
192Returns:
193 A request object that you can call &#x27;execute()&#x27; on to request the next
194 page. Returns None if there are no more items in the collection.
195 </pre>
196</div>
197
198<div class="method">
199 <code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]200 <pre>Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201
202Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]203 name: string, Required. The resource name of the assignment, e.g. `projects/myproject/locations/US/reservations/team1-prod/assignments/123` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]204 body: object, The request body.
205 The object takes the form of:
206
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]207{ # The request for ReservationService.MoveAssignment. **Note**: &quot;bigquery.reservationAssignments.create&quot; permission is required on the destination_id. **Note**: &quot;bigquery.reservationAssignments.create&quot; and &quot;bigquery.reservationAssignments.delete&quot; permission are required on the related assignee.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]208 &quot;destinationId&quot;: &quot;A String&quot;, # The new reservation ID, e.g.: `projects/myotherproject/locations/US/reservations/team2-prod`
209}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210
211 x__xgafv: string, V1 error format.
212 Allowed values
213 1 - v1 error format
214 2 - v2 error format
215
216Returns:
217 An object of the form:
218
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]219 { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]220 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
221 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
222 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
223 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
224}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]225</div>
226
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700[diff] [blame^]227<div class="method">
228 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
229 <pre>Updates an existing assignment. Only the `priority` field can be updated.
230
231Args:
232 name: string, Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. (required)
233 body: object, The request body.
234 The object takes the form of:
235
236{ # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
237 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
238 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
239 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
240 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
241}
242
243 updateMask: string, Standard field mask for the set of fields to be updated.
244 x__xgafv: string, V1 error format.
245 Allowed values
246 1 - v1 error format
247 2 - v2 error format
248
249Returns:
250 An object of the form:
251
252 { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
253 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
254 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
255 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
256 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
257}</pre>
258</div>
259
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]260</body></html>