| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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.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="#getBiReservation">getBiReservation(name, x__xgafv=None)</a></code></p> |
| 89 | <p class="firstline">Retrieves a BI reservation.</p> |
| 90 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 91 | <code><a href="#searchAllAssignments">searchAllAssignments(parent, query=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 92 | <p class="firstline">Looks up assignments for a specified resource for a particular region.</p> |
| 93 | <p class="toc_element"> |
| 94 | <code><a href="#searchAllAssignments_next">searchAllAssignments_next(previous_request, previous_response)</a></code></p> |
| 95 | <p class="firstline">Retrieves the next page of results.</p> |
| 96 | <p class="toc_element"> |
| 97 | <code><a href="#searchAssignments">searchAssignments(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 98 | <p class="firstline">Looks up assignments for a specified resource for a particular region.</p> |
| 99 | <p class="toc_element"> |
| 100 | <code><a href="#searchAssignments_next">searchAssignments_next(previous_request, previous_response)</a></code></p> |
| 101 | <p class="firstline">Retrieves the next page of results.</p> |
| 102 | <p class="toc_element"> |
| 103 | <code><a href="#updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 104 | <p class="firstline">Updates a BI reservation.</p> |
| 105 | <h3>Method Details</h3> |
| 106 | <div class="method"> |
| 107 | <code class="details" id="getBiReservation">getBiReservation(name, x__xgafv=None)</code> |
| 108 | <pre>Retrieves a BI reservation. |
| 109 | |
| 110 | Args: |
| 111 | name: string, Required. Name of the requested reservation, for example: |
| 112 | `projects/{project_id}/locations/{location_id}/bireservation` (required) |
| 113 | x__xgafv: string, V1 error format. |
| 114 | Allowed values |
| 115 | 1 - v1 error format |
| 116 | 2 - v2 error format |
| 117 | |
| 118 | Returns: |
| 119 | An object of the form: |
| 120 | |
| 121 | { # Represents a BI Reservation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 122 | "name": "A String", # The resource name of the singleton BI reservation. |
| 123 | # Reservation names have the form |
| 124 | # `projects/{project_id}/locations/{location_id}/bireservation`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 125 | "updateTime": "A String", # Output only. The last update timestamp of a reservation. |
| 126 | "size": "A String", # Size of a reservation, in bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 127 | }</pre> |
| 128 | </div> |
| 129 | |
| 130 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 131 | <code class="details" id="searchAllAssignments">searchAllAssignments(parent, query=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 132 | <pre>Looks up assignments for a specified resource for a particular region. |
| 133 | If the request is about a project: |
| 134 | |
| 135 | 1. Assignments created on the project will be returned if they exist. |
| 136 | 2. Otherwise assignments created on the closest ancestor will be |
| 137 | returned. |
| 138 | 3. Assignments for different JobTypes will all be returned. |
| 139 | |
| 140 | The same logic applies if the request is about a folder. |
| 141 | |
| 142 | If the request is about an organization, then assignments created on the |
| 143 | organization will be returned (organization doesn't have ancestors). |
| 144 | |
| 145 | Comparing to ListAssignments, there are some behavior |
| 146 | differences: |
| 147 | |
| 148 | 1. permission on the assignee will be verified in this API. |
| 149 | 2. Hierarchy lookup (project->folder->organization) happens in this API. |
| 150 | 3. Parent here is `projects/*/locations/*`, instead of |
| 151 | `projects/*/locations/*reservations/*`. |
| 152 | |
| 153 | Args: |
| 154 | parent: string, Required. The resource name with location (project name could be the wildcard '-'), |
| 155 | e.g.: |
| 156 | `projects/-/locations/US`. (required) |
| 157 | query: string, Please specify resource name as assignee in the query. |
| 158 | |
| 159 | Examples: |
| 160 | |
| 161 | * `assignee=projects/myproject` |
| 162 | * `assignee=folders/123` |
| 163 | * `assignee=organizations/456` |
| 164 | pageSize: integer, The maximum number of items to return per page. |
| 165 | pageToken: string, The next_page_token value returned from a previous List request, if any. |
| 166 | x__xgafv: string, V1 error format. |
| 167 | Allowed values |
| 168 | 1 - v1 error format |
| 169 | 2 - v2 error format |
| 170 | |
| 171 | Returns: |
| 172 | An object of the form: |
| 173 | |
| 174 | { # The response for ReservationService.SearchAllAssignments. |
| 175 | "assignments": [ # List of assignments visible to the user. |
| 176 | { # A Assignment allows a project to submit jobs |
| 177 | # of a certain type using slots from the specified reservation. |
| 178 | "assignee": "A String", # The resource which will use the reservation. E.g. |
| 179 | # `projects/myproject`, `folders/123`, or `organizations/456`. |
| 180 | "name": "A String", # Output only. Name of the resource. E.g.: |
| 181 | # `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. |
| 182 | "state": "A String", # Output only. State of the assignment. |
| 183 | "jobType": "A String", # Which type of jobs will use the reservation. |
| 184 | }, |
| 185 | ], |
| 186 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 187 | # more results in the list. |
| 188 | }</pre> |
| 189 | </div> |
| 190 | |
| 191 | <div class="method"> |
| 192 | <code class="details" id="searchAllAssignments_next">searchAllAssignments_next(previous_request, previous_response)</code> |
| 193 | <pre>Retrieves the next page of results. |
| 194 | |
| 195 | Args: |
| 196 | previous_request: The request for the previous page. (required) |
| 197 | previous_response: The response from the request for the previous page. (required) |
| 198 | |
| 199 | Returns: |
| 200 | A request object that you can call 'execute()' on to request the next |
| 201 | page. Returns None if there are no more items in the collection. |
| 202 | </pre> |
| 203 | </div> |
| 204 | |
| 205 | <div class="method"> |
| 206 | <code class="details" id="searchAssignments">searchAssignments(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 207 | <pre>Looks up assignments for a specified resource for a particular region. |
| 208 | If the request is about a project: |
| 209 | |
| 210 | 1. Assignments created on the project will be returned if they exist. |
| 211 | 2. Otherwise assignments created on the closest ancestor will be |
| 212 | returned. |
| 213 | 3. Assignments for different JobTypes will all be returned. |
| 214 | |
| 215 | The same logic applies if the request is about a folder. |
| 216 | |
| 217 | If the request is about an organization, then assignments created on the |
| 218 | organization will be returned (organization doesn't have ancestors). |
| 219 | |
| 220 | Comparing to ListAssignments, there are some behavior |
| 221 | differences: |
| 222 | |
| 223 | 1. permission on the assignee will be verified in this API. |
| 224 | 2. Hierarchy lookup (project->folder->organization) happens in this API. |
| 225 | 3. Parent here is `projects/*/locations/*`, instead of |
| 226 | `projects/*/locations/*reservations/*`. |
| 227 | |
| 228 | **Note** "-" cannot be used for projects |
| 229 | nor locations. |
| 230 | |
| 231 | Args: |
| 232 | parent: string, Required. The resource name of the admin project(containing project and location), |
| 233 | e.g.: |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 234 | `projects/myproject/locations/US`. (required) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 235 | pageSize: integer, The maximum number of items to return per page. |
| 236 | pageToken: string, The next_page_token value returned from a previous List request, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | query: string, Please specify resource name as assignee in the query. |
| 238 | |
| 239 | Examples: |
| 240 | |
| 241 | * `assignee=projects/myproject` |
| 242 | * `assignee=folders/123` |
| 243 | * `assignee=organizations/456` |
| 244 | x__xgafv: string, V1 error format. |
| 245 | Allowed values |
| 246 | 1 - v1 error format |
| 247 | 2 - v2 error format |
| 248 | |
| 249 | Returns: |
| 250 | An object of the form: |
| 251 | |
| 252 | { # The response for ReservationService.SearchAssignments. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 253 | "assignments": [ # List of assignments visible to the user. |
| 254 | { # A Assignment allows a project to submit jobs |
| 255 | # of a certain type using slots from the specified reservation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 256 | "assignee": "A String", # The resource which will use the reservation. E.g. |
| 257 | # `projects/myproject`, `folders/123`, or `organizations/456`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 258 | "name": "A String", # Output only. Name of the resource. E.g.: |
| 259 | # `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. |
| 260 | "state": "A String", # Output only. State of the assignment. |
| 261 | "jobType": "A String", # Which type of jobs will use the reservation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 262 | }, |
| 263 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 264 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 265 | # more results in the list. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 266 | }</pre> |
| 267 | </div> |
| 268 | |
| 269 | <div class="method"> |
| 270 | <code class="details" id="searchAssignments_next">searchAssignments_next(previous_request, previous_response)</code> |
| 271 | <pre>Retrieves the next page of results. |
| 272 | |
| 273 | Args: |
| 274 | previous_request: The request for the previous page. (required) |
| 275 | previous_response: The response from the request for the previous page. (required) |
| 276 | |
| 277 | Returns: |
| 278 | A request object that you can call 'execute()' on to request the next |
| 279 | page. Returns None if there are no more items in the collection. |
| 280 | </pre> |
| 281 | </div> |
| 282 | |
| 283 | <div class="method"> |
| 284 | <code class="details" id="updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 285 | <pre>Updates a BI reservation. |
| 286 | |
| 287 | Only fields specified in the `field_mask` are updated. |
| 288 | |
| 289 | A singleton BI reservation always exists with default size 0. |
| 290 | In order to reserve BI capacity it needs to be updated to an amount |
| 291 | greater than 0. In order to release BI capacity reservation size |
| 292 | must be set to 0. |
| 293 | |
| 294 | Args: |
| 295 | name: string, The resource name of the singleton BI reservation. |
| 296 | Reservation names have the form |
| 297 | `projects/{project_id}/locations/{location_id}/bireservation`. (required) |
| 298 | body: object, The request body. |
| 299 | The object takes the form of: |
| 300 | |
| 301 | { # Represents a BI Reservation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 302 | "name": "A String", # The resource name of the singleton BI reservation. |
| 303 | # Reservation names have the form |
| 304 | # `projects/{project_id}/locations/{location_id}/bireservation`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 305 | "updateTime": "A String", # Output only. The last update timestamp of a reservation. |
| 306 | "size": "A String", # Size of a reservation, in bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | } |
| 308 | |
| 309 | updateMask: string, A list of fields to be updated in this request. |
| 310 | x__xgafv: string, V1 error format. |
| 311 | Allowed values |
| 312 | 1 - v1 error format |
| 313 | 2 - v2 error format |
| 314 | |
| 315 | Returns: |
| 316 | An object of the form: |
| 317 | |
| 318 | { # Represents a BI Reservation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 319 | "name": "A String", # The resource name of the singleton BI reservation. |
| 320 | # Reservation names have the form |
| 321 | # `projects/{project_id}/locations/{location_id}/bireservation`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 322 | "updateTime": "A String", # Output only. The last update timestamp of a reservation. |
| 323 | "size": "A String", # Size of a reservation, in bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 324 | }</pre> |
| 325 | </div> |
| 326 | |
| 327 | </body></html> |