Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0bf565cdd7eac073130c7d9700285524a0efd1a3 / . / docs / dyn / bigqueryreservation_v1.projects.locations.reservations.assignments.html
blob: 3a7c79346089927acd87906dc1ca3a33b276246b [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[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. 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>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <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. 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]104
105Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106 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]107 body: object, The request body.
108 The object takes the form of:
109
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]110{ # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]111 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]112 &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]113 &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]114 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125 { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]126 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]127 &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]128 &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]129 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 }</pre>
131</div>
132
133<div class="method">
134 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]135 <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]136
137Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]138 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]139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]147 { # 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 `{}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]148 }</pre>
149</div>
150
151<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]152 <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]153 <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]154
155Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]156 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]157 pageSize: integer, The maximum number of items to return per page.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]158 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]159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164Returns:
165 An object of the form:
166
167 { # The response for ReservationService.ListAssignments.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 &quot;assignments&quot;: [ # List of assignments visible to the user.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]169 { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]170 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]171 &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]172 &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]173 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 },
175 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]176 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
182 <pre>Retrieves the next page of results.
183
184Args:
185 previous_request: The request for the previous page. (required)
186 previous_response: The response from the request for the previous page. (required)
187
188Returns:
189 A request object that you can call &#x27;execute()&#x27; on to request the next
190 page. Returns None if there are no more items in the collection.
191 </pre>
192</div>
193
194<div class="method">
195 <code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]196 <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]197
198Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]199 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]200 body: object, The request body.
201 The object takes the form of:
202
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]203{ # 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.
204 &quot;destinationId&quot;: &quot;A String&quot;, # The new reservation ID, e.g.: `projects/myotherproject/locations/US/reservations/team2-prod`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 }
206
207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
211
212Returns:
213 An object of the form:
214
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]215 { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]216 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]217 &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]218 &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]219 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]220 }</pre>
221</div>
222
223</body></html>