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_v1beta1.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1beta1.projects.html">projects</a> . <a href="bigqueryreservation_v1beta1.projects.locations.html">locations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="bigqueryreservation_v1beta1.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_v1beta1.projects.locations.reservations.html">reservations()</a></code> 84</p> 85<p class="firstline">Returns the reservations Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 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"> 94 <code><a href="#searchAssignments">searchAssignments(parent, pageSize=None, pageToken=None, query=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/*`. **Note** "-" cannot be used for projects nor locations.</p> 96<p class="toc_element"> 97 <code><a href="#searchAssignments_next">searchAssignments_next(previous_request, previous_response)</a></code></p> 98<p class="firstline">Retrieves the next page of results.</p> 99<p class="toc_element"> 100 <code><a href="#updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 101<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> 102<h3>Method Details</h3> 103<div class="method"> 104 <code class="details" id="close">close()</code> 105 <pre>Close httplib2 connections.</pre> 106</div> 107 108<div class="method"> 109 <code class="details" id="getBiReservation">getBiReservation(name, x__xgafv=None)</code> 110 <pre>Retrieves a BI reservation. 111 112Args: 113 name: string, Required. Name of the requested reservation, for example: `projects/{project_id}/locations/{location_id}/biReservation` (required) 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # Represents a BI Reservation. 123 "name": "A String", # The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`. 124 "size": "A String", # Size of a reservation, in bytes. 125 "updateTime": "A String", # Output only. The last update timestamp of a reservation. 126}</pre> 127</div> 128 129<div class="method"> 130 <code class="details" id="searchAssignments">searchAssignments(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</code> 131 <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'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. 132 133Args: 134 parent: string, Required. The resource name of the admin project(containing project and location), e.g.: `projects/myproject/locations/US`. (required) 135 pageSize: integer, The maximum number of items to return. 136 pageToken: string, The next_page_token value returned from a previous List request, if any. 137 query: string, Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456` 138 x__xgafv: string, V1 error format. 139 Allowed values 140 1 - v1 error format 141 2 - v2 error format 142 143Returns: 144 An object of the form: 145 146 { # The response for ReservationService.SearchAssignments. 147 "assignments": [ # List of assignments visible to the user. 148 { # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. 149 "assignee": "A String", # The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. 150 "jobType": "A String", # Which type of jobs will use the reservation. 151 "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. 152 "state": "A String", # Output only. State of the assignment. 153 }, 154 ], 155 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 156}</pre> 157</div> 158 159<div class="method"> 160 <code class="details" id="searchAssignments_next">searchAssignments_next(previous_request, previous_response)</code> 161 <pre>Retrieves the next page of results. 162 163Args: 164 previous_request: The request for the previous page. (required) 165 previous_response: The response from the request for the previous page. (required) 166 167Returns: 168 A request object that you can call 'execute()' on to request the next 169 page. Returns None if there are no more items in the collection. 170 </pre> 171</div> 172 173<div class="method"> 174 <code class="details" id="updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</code> 175 <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. 176 177Args: 178 name: string, The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`. (required) 179 body: object, The request body. 180 The object takes the form of: 181 182{ # Represents a BI Reservation. 183 "name": "A String", # The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`. 184 "size": "A String", # Size of a reservation, in bytes. 185 "updateTime": "A String", # Output only. The last update timestamp of a reservation. 186} 187 188 updateMask: string, A list of fields to be updated in this request. 189 x__xgafv: string, V1 error format. 190 Allowed values 191 1 - v1 error format 192 2 - v2 error format 193 194Returns: 195 An object of the form: 196 197 { # Represents a BI Reservation. 198 "name": "A String", # The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`. 199 "size": "A String", # Size of a reservation, in bytes. 200 "updateTime": "A String", # Output only. The last update timestamp of a reservation. 201}</pre> 202</div> 203 204</body></html>