Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / bigqueryreservation_v1.projects.locations.html
blob: 26d8b98c4df5dc0dffbaa6d686818939d497166d [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></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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]91 <code><a href="#getBiReservation">getBiReservation(name, x__xgafv=None)</a></code></p>
92<p class="firstline">Retrieves a BI reservation.</p>
93<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]94 <code><a href="#searchAllAssignments">searchAllAssignments(parent, pageToken=None, query=None, pageSize=None, x__xgafv=None)</a></code></p>
95<p class="firstline">Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project->folder->organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]96<p class="toc_element">
97 <code><a href="#searchAllAssignments_next">searchAllAssignments_next(previous_request, previous_response)</a></code></p>
98<p class="firstline">Retrieves the next page of results.</p>
99<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]100 <code><a href="#searchAssignments">searchAssignments(parent, query=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
101<p class="firstline">Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project->folder->organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`. **Note** "-" cannot be used for projects nor locations.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102<p class="toc_element">
103 <code><a href="#searchAssignments_next">searchAssignments_next(previous_request, previous_response)</a></code></p>
104<p class="firstline">Retrieves the next page of results.</p>
105<p class="toc_element">
106 <code><a href="#updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]107<p class="firstline">Updates a BI reservation. Only fields specified in the `field_mask` are updated. A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108<h3>Method Details</h3>
109<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]110 <code class="details" id="close">close()</code>
111 <pre>Close httplib2 connections.</pre>
112</div>
113
114<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 <code class="details" id="getBiReservation">getBiReservation(name, x__xgafv=None)</code>
116 <pre>Retrieves a BI reservation.
117
118Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]119 name: string, Required. Name of the requested reservation, for example: `projects/{project_id}/locations/{location_id}/bireservation` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125Returns:
126 An object of the form:
127
128 { # Represents a BI Reservation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]129 &quot;name&quot;: &quot;A String&quot;, # The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/bireservation`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]130 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of a reservation.
131 &quot;size&quot;: &quot;A String&quot;, # Size of a reservation, in bytes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 }</pre>
133</div>
134
135<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]136 <code class="details" id="searchAllAssignments">searchAllAssignments(parent, pageToken=None, query=None, pageSize=None, x__xgafv=None)</code>
137 <pre>Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn&#x27;t have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project-&gt;folder-&gt;organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138
139Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]140 parent: string, Required. The resource name with location (project name could be the wildcard &#x27;-&#x27;), e.g.: `projects/-/locations/US`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]141 pageToken: string, The next_page_token value returned from a previous List request, if any.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]142 query: string, Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`
143 pageSize: integer, The maximum number of items to return per page.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149Returns:
150 An object of the form:
151
152 { # The response for ReservationService.SearchAllAssignments.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]153 &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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]154 &quot;assignments&quot;: [ # List of assignments visible to the user.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]155 { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
156 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
157 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]158 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]159 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]160 },
161 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="searchAllAssignments_next">searchAllAssignments_next(previous_request, previous_response)</code>
167 <pre>Retrieves the next page of results.
168
169Args:
170 previous_request: The request for the previous page. (required)
171 previous_response: The response from the request for the previous page. (required)
172
173Returns:
174 A request object that you can call &#x27;execute()&#x27; on to request the next
175 page. Returns None if there are no more items in the collection.
176 </pre>
177</div>
178
179<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]180 <code class="details" id="searchAssignments">searchAssignments(parent, query=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
181 <pre>Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn&#x27;t have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project-&gt;folder-&gt;organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`. **Note** &quot;-&quot; cannot be used for projects nor locations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182
183Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]184 parent: string, Required. The resource name of the admin project(containing project and location), e.g.: `projects/myproject/locations/US`. (required)
185 query: string, Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]186 pageSize: integer, The maximum number of items to return per page.
187 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]188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193Returns:
194 An object of the form:
195
196 { # The response for ReservationService.SearchAssignments.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 &quot;assignments&quot;: [ # List of assignments visible to the user.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]198 { # A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
199 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
200 &quot;assignee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]201 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]202 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 },
204 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]205 &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]206 }</pre>
207</div>
208
209<div class="method">
210 <code class="details" id="searchAssignments_next">searchAssignments_next(previous_request, previous_response)</code>
211 <pre>Retrieves the next page of results.
212
213Args:
214 previous_request: The request for the previous page. (required)
215 previous_response: The response from the request for the previous page. (required)
216
217Returns:
218 A request object that you can call &#x27;execute()&#x27; on to request the next
219 page. Returns None if there are no more items in the collection.
220 </pre>
221</div>
222
223<div class="method">
224 <code class="details" id="updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]225 <pre>Updates a BI reservation. Only fields specified in the `field_mask` are updated. A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226
227Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]228 name: string, The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/bireservation`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 body: object, The request body.
230 The object takes the form of:
231
232{ # Represents a BI Reservation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]233 &quot;name&quot;: &quot;A String&quot;, # The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/bireservation`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]234 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of a reservation.
235 &quot;size&quot;: &quot;A String&quot;, # Size of a reservation, in bytes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236}
237
238 updateMask: string, A list of fields to be updated in this request.
239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
243
244Returns:
245 An object of the form:
246
247 { # Represents a BI Reservation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]248 &quot;name&quot;: &quot;A String&quot;, # The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/bireservation`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]249 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of a reservation.
250 &quot;size&quot;: &quot;A String&quot;, # Size of a reservation, in bytes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]251 }</pre>
252</div>
253
254</body></html>