Debian Codegraph @

docs/dyn/bigqueryreservation_v1.projects.locations.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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.reservationGroups.html">reservationGroups()</a></code>
84 </p>
85 <p class="firstline">Returns the reservationGroups Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="bigqueryreservation_v1.projects.locations.reservations.html">reservations()</a></code>
89 </p>
90 <p class="firstline">Returns the reservations Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="#close">close()</a></code></p>
94 <p class="firstline">Close httplib2 connections.</p>
95 <p class="toc_element">
96 <code><a href="#getBiReservation">getBiReservation(name, x__xgafv=None)</a></code></p>
97 <p class="firstline">Retrieves a BI reservation.</p>
98 <p class="toc_element">
99 <code><a href="#searchAllAssignments">searchAllAssignments(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
100 <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>
101 <p class="toc_element">
102 <code><a href="#searchAllAssignments_next">searchAllAssignments_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#searchAssignments">searchAssignments(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Deprecated: 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>
107 <p class="toc_element">
108 <code><a href="#searchAssignments_next">searchAssignments_next()</a></code></p>
109 <p class="firstline">Retrieves the next page of results.</p>
110 <p class="toc_element">
111 <code><a href="#updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
112 <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>
113 <h3>Method Details</h3>
114 <div class="method">
115 <code class="details" id="close">close()</code>
116 <pre>Close httplib2 connections.</pre>
117 </div>
118
119 <div class="method">
120 <code class="details" id="getBiReservation">getBiReservation(name, x__xgafv=None)</code>
121 <pre>Retrieves a BI reservation.
122
123 Args:
124 name: string, Required. Name of the requested reservation, for example: `projects/{project_id}/locations/{location_id}/biReservation` (required)
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130 Returns:
131 An object of the form:
132
133 { # Represents a BI Reservation.
134 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`.
135 &quot;preferredTables&quot;: [ # Optional. Preferred tables to use BI capacity for.
136 { # Fully qualified reference to BigQuery table. Internally stored as google.cloud.bi.v1.BqTableReference.
137 &quot;datasetId&quot;: &quot;A String&quot;, # Optional. The ID of the dataset in the above project.
138 &quot;projectId&quot;: &quot;A String&quot;, # Optional. The assigned project ID of the project.
139 &quot;tableId&quot;: &quot;A String&quot;, # Optional. The ID of the table in the above dataset.
140 },
141 ],
142 &quot;size&quot;: &quot;A String&quot;, # Optional. Size of a reservation, in bytes.
143 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of a reservation.
144 }</pre>
145 </div>
146
147 <div class="method">
148 <code class="details" id="searchAllAssignments">searchAllAssignments(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</code>
149 <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/*`.
150
151 Args:
152 parent: string, Required. The resource name with location (project name could be the wildcard &#x27;-&#x27;), e.g.: `projects/-/locations/US`. (required)
153 pageSize: integer, The maximum number of items to return per page.
154 pageToken: string, The next_page_token value returned from a previous List request, if any.
155 query: string, Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`
156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
160
161 Returns:
162 An object of the form:
163
164 { # The response for ReservationService.SearchAllAssignments.
165 &quot;assignments&quot;: [ # List of assignments visible to the user.
166 { # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
167 &quot;assignee&quot;: &quot;A String&quot;, # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
168 &quot;enableGeminiInBigquery&quot;: True or False, # Optional. Deprecated: &quot;Gemini in BigQuery&quot; is now available by default for all BigQuery editions and should not be explicitly set. Controls if &quot;Gemini in BigQuery&quot; (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment.
169 &quot;jobType&quot;: &quot;A String&quot;, # Optional. Which type of jobs will use the reservation.
170 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
171 &quot;principal&quot;: &quot;A String&quot;, # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users.
172 &quot;schedulingPolicy&quot;: { # The scheduling policy controls how a reservation&#x27;s resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation&#x27;s resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
173 &quot;concurrency&quot;: &quot;A String&quot;, # Optional. If present and &gt; 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
174 &quot;maxSlots&quot;: &quot;A String&quot;, # Optional. If present and &gt; 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
175 },
176 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
177 },
178 ],
179 &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.
180 }</pre>
181 </div>
182
183 <div class="method">
184 <code class="details" id="searchAllAssignments_next">searchAllAssignments_next()</code>
185 <pre>Retrieves the next page of results.
186
187 Args:
188 previous_request: The request for the previous page. (required)
189 previous_response: The response from the request for the previous page. (required)
190
191 Returns:
192 A request object that you can call &#x27;execute()&#x27; on to request the next
193 page. Returns None if there are no more items in the collection.
194 </pre>
195 </div>
196
197 <div class="method">
198 <code class="details" id="searchAssignments">searchAssignments(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</code>
199 <pre>Deprecated: 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.
200
201 Args:
202 parent: string, Required. The resource name of the admin project(containing project and location), e.g.: `projects/myproject/locations/US`. (required)
203 pageSize: integer, The maximum number of items to return per page.
204 pageToken: string, The next_page_token value returned from a previous List request, if any.
205 query: string, Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`
206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
210
211 Returns:
212 An object of the form:
213
214 { # The response for ReservationService.SearchAssignments.
215 &quot;assignments&quot;: [ # List of assignments visible to the user.
216 { # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.
217 &quot;assignee&quot;: &quot;A String&quot;, # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.
218 &quot;enableGeminiInBigquery&quot;: True or False, # Optional. Deprecated: &quot;Gemini in BigQuery&quot; is now available by default for all BigQuery editions and should not be explicitly set. Controls if &quot;Gemini in BigQuery&quot; (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment.
219 &quot;jobType&quot;: &quot;A String&quot;, # Optional. Which type of jobs will use the reservation.
220 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
221 &quot;principal&quot;: &quot;A String&quot;, # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users.
222 &quot;schedulingPolicy&quot;: { # The scheduling policy controls how a reservation&#x27;s resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation&#x27;s resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
223 &quot;concurrency&quot;: &quot;A String&quot;, # Optional. If present and &gt; 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
224 &quot;maxSlots&quot;: &quot;A String&quot;, # Optional. If present and &gt; 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
225 },
226 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the assignment.
227 },
228 ],
229 &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.
230 }</pre>
231 </div>
232
233 <div class="method">
234 <code class="details" id="searchAssignments_next">searchAssignments_next()</code>
235 <pre>Retrieves the next page of results.
236
237 Args:
238 previous_request: The request for the previous page. (required)
239 previous_response: The response from the request for the previous page. (required)
240
241 Returns:
242 A request object that you can call &#x27;execute()&#x27; on to request the next
243 page. Returns None if there are no more items in the collection.
244 </pre>
245 </div>
246
247 <div class="method">
248 <code class="details" id="updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</code>
249 <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.
250
251 Args:
252 name: string, Identifier. The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`. (required)
253 body: object, The request body.
254 The object takes the form of:
255
256 { # Represents a BI Reservation.
257 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`.
258 &quot;preferredTables&quot;: [ # Optional. Preferred tables to use BI capacity for.
259 { # Fully qualified reference to BigQuery table. Internally stored as google.cloud.bi.v1.BqTableReference.
260 &quot;datasetId&quot;: &quot;A String&quot;, # Optional. The ID of the dataset in the above project.
261 &quot;projectId&quot;: &quot;A String&quot;, # Optional. The assigned project ID of the project.
262 &quot;tableId&quot;: &quot;A String&quot;, # Optional. The ID of the table in the above dataset.
263 },
264 ],
265 &quot;size&quot;: &quot;A String&quot;, # Optional. Size of a reservation, in bytes.
266 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of a reservation.
267 }
268
269 updateMask: string, A list of fields to be updated in this request.
270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275 Returns:
276 An object of the form:
277
278 { # Represents a BI Reservation.
279 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`.
280 &quot;preferredTables&quot;: [ # Optional. Preferred tables to use BI capacity for.
281 { # Fully qualified reference to BigQuery table. Internally stored as google.cloud.bi.v1.BqTableReference.
282 &quot;datasetId&quot;: &quot;A String&quot;, # Optional. The ID of the dataset in the above project.
283 &quot;projectId&quot;: &quot;A String&quot;, # Optional. The assigned project ID of the project.
284 &quot;tableId&quot;: &quot;A String&quot;, # Optional. The ID of the table in the above dataset.
285 },
286 ],
287 &quot;size&quot;: &quot;A String&quot;, # Optional. Size of a reservation, in bytes.
288 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of a reservation.
289 }</pre>
290 </div>
291
292 </body></html>