| 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_v1beta1.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1beta1.projects.html">projects</a> . <a href="bigqueryreservation_v1beta1.projects.locations.html">locations</a> . <a href="bigqueryreservation_v1beta1.projects.locations.reservations.html">reservations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html">assignments()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the assignments Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#create">create(parent, body=None, reservationId=None, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Creates a new reservation resource.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Deletes a reservation.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Returns information about the reservation.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Lists all the reservations for the project in the specified location.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 96 | <p class="firstline">Retrieves the next page of results.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 99 | <p class="firstline">Updates an existing reservation resource.</p> |
| 100 | <h3>Method Details</h3> |
| 101 | <div class="method"> |
| 102 | <code class="details" id="create">create(parent, body=None, reservationId=None, x__xgafv=None)</code> |
| 103 | <pre>Creates a new reservation resource. |
| 104 | |
| 105 | Args: |
| 106 | parent: string, Required. Project, location. E.g., |
| 107 | projects/myproject/locations/US (required) |
| 108 | body: object, The request body. |
| 109 | The object takes the form of: |
| 110 | |
| 111 | { # A reservation is a mechanism used to guarantee slots to users. |
| 112 | "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of |
| 113 | # computational power in BigQuery, and serves as the unit of parallelism. |
| 114 | # Queries using this reservation might use more slots during runtime if |
| 115 | # ignore_idle_slots is set to false. |
| 116 | # If the new reservation's slot capacity exceed the parent's slot capacity or |
| 117 | # if total slot capacity of the new reservation and its siblings exceeds the |
| 118 | # parent's slot capacity, the request will fail with |
| 119 | # `google.rpc.Code.RESOURCE_EXHAUSTED`. |
| 120 | "name": "A String", # The resource name of the reservation, e.g., |
| 121 | # "projects/*/locations/*/reservations/team1-prod". |
| 122 | "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other |
| 123 | # reservations within the same admin project. If true, a query using this |
| 124 | # reservation will execute with the slot capacity specified above at most. |
| 125 | } |
| 126 | |
| 127 | reservationId: string, The reservation ID. This field must only contain lower case alphanumeric |
| 128 | characters or dash. Max length is 64 characters. |
| 129 | x__xgafv: string, V1 error format. |
| 130 | Allowed values |
| 131 | 1 - v1 error format |
| 132 | 2 - v2 error format |
| 133 | |
| 134 | Returns: |
| 135 | An object of the form: |
| 136 | |
| 137 | { # A reservation is a mechanism used to guarantee slots to users. |
| 138 | "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of |
| 139 | # computational power in BigQuery, and serves as the unit of parallelism. |
| 140 | # Queries using this reservation might use more slots during runtime if |
| 141 | # ignore_idle_slots is set to false. |
| 142 | # If the new reservation's slot capacity exceed the parent's slot capacity or |
| 143 | # if total slot capacity of the new reservation and its siblings exceeds the |
| 144 | # parent's slot capacity, the request will fail with |
| 145 | # `google.rpc.Code.RESOURCE_EXHAUSTED`. |
| 146 | "name": "A String", # The resource name of the reservation, e.g., |
| 147 | # "projects/*/locations/*/reservations/team1-prod". |
| 148 | "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other |
| 149 | # reservations within the same admin project. If true, a query using this |
| 150 | # reservation will execute with the slot capacity specified above at most. |
| 151 | }</pre> |
| 152 | </div> |
| 153 | |
| 154 | <div class="method"> |
| 155 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 156 | <pre>Deletes a reservation. |
| 157 | Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has |
| 158 | assignments. |
| 159 | |
| 160 | Args: |
| 161 | name: string, Required. Resource name of the reservation to retrieve. E.g., |
| 162 | projects/myproject/locations/US/reservations/team1-prod (required) |
| 163 | x__xgafv: string, V1 error format. |
| 164 | Allowed values |
| 165 | 1 - v1 error format |
| 166 | 2 - v2 error format |
| 167 | |
| 168 | Returns: |
| 169 | An object of the form: |
| 170 | |
| 171 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 172 | # empty messages in your APIs. A typical example is to use it as the request |
| 173 | # or the response type of an API method. For instance: |
| 174 | # |
| 175 | # service Foo { |
| 176 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 177 | # } |
| 178 | # |
| 179 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 180 | }</pre> |
| 181 | </div> |
| 182 | |
| 183 | <div class="method"> |
| 184 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 185 | <pre>Returns information about the reservation. |
| 186 | |
| 187 | Args: |
| 188 | name: string, Required. Resource name of the reservation to retrieve. E.g., |
| 189 | projects/myproject/locations/US/reservations/team1-prod (required) |
| 190 | x__xgafv: string, V1 error format. |
| 191 | Allowed values |
| 192 | 1 - v1 error format |
| 193 | 2 - v2 error format |
| 194 | |
| 195 | Returns: |
| 196 | An object of the form: |
| 197 | |
| 198 | { # A reservation is a mechanism used to guarantee slots to users. |
| 199 | "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of |
| 200 | # computational power in BigQuery, and serves as the unit of parallelism. |
| 201 | # Queries using this reservation might use more slots during runtime if |
| 202 | # ignore_idle_slots is set to false. |
| 203 | # If the new reservation's slot capacity exceed the parent's slot capacity or |
| 204 | # if total slot capacity of the new reservation and its siblings exceeds the |
| 205 | # parent's slot capacity, the request will fail with |
| 206 | # `google.rpc.Code.RESOURCE_EXHAUSTED`. |
| 207 | "name": "A String", # The resource name of the reservation, e.g., |
| 208 | # "projects/*/locations/*/reservations/team1-prod". |
| 209 | "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other |
| 210 | # reservations within the same admin project. If true, a query using this |
| 211 | # reservation will execute with the slot capacity specified above at most. |
| 212 | }</pre> |
| 213 | </div> |
| 214 | |
| 215 | <div class="method"> |
| 216 | <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code> |
| 217 | <pre>Lists all the reservations for the project in the specified location. |
| 218 | |
| 219 | Args: |
| 220 | parent: string, Required. The parent resource name containing project and location, e.g.: |
| 221 | "projects/myproject/locations/US" (required) |
| 222 | pageSize: integer, The maximum number of items to return. |
| 223 | filter: string, Can be used to filter out reservations based on names, capacity, etc, e.g.: |
| 224 | filter="reservation.slot_capacity > 200" |
| 225 | filter="reservation.name = \"*dev/*\"" |
| 226 | Advanced filtering syntax can be |
| 227 | [here](https://cloud.google.com/logging/docs/view/advanced-filters). |
| 228 | pageToken: string, The next_page_token value returned from a previous List request, if any. |
| 229 | x__xgafv: string, V1 error format. |
| 230 | Allowed values |
| 231 | 1 - v1 error format |
| 232 | 2 - v2 error format |
| 233 | |
| 234 | Returns: |
| 235 | An object of the form: |
| 236 | |
| 237 | { # The response for ReservationService.ListReservations. |
| 238 | "reservations": [ # List of reservations visible to the user. |
| 239 | { # A reservation is a mechanism used to guarantee slots to users. |
| 240 | "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of |
| 241 | # computational power in BigQuery, and serves as the unit of parallelism. |
| 242 | # Queries using this reservation might use more slots during runtime if |
| 243 | # ignore_idle_slots is set to false. |
| 244 | # If the new reservation's slot capacity exceed the parent's slot capacity or |
| 245 | # if total slot capacity of the new reservation and its siblings exceeds the |
| 246 | # parent's slot capacity, the request will fail with |
| 247 | # `google.rpc.Code.RESOURCE_EXHAUSTED`. |
| 248 | "name": "A String", # The resource name of the reservation, e.g., |
| 249 | # "projects/*/locations/*/reservations/team1-prod". |
| 250 | "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other |
| 251 | # reservations within the same admin project. If true, a query using this |
| 252 | # reservation will execute with the slot capacity specified above at most. |
| 253 | }, |
| 254 | ], |
| 255 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 256 | # more results in the list. |
| 257 | }</pre> |
| 258 | </div> |
| 259 | |
| 260 | <div class="method"> |
| 261 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 262 | <pre>Retrieves the next page of results. |
| 263 | |
| 264 | Args: |
| 265 | previous_request: The request for the previous page. (required) |
| 266 | previous_response: The response from the request for the previous page. (required) |
| 267 | |
| 268 | Returns: |
| 269 | A request object that you can call 'execute()' on to request the next |
| 270 | page. Returns None if there are no more items in the collection. |
| 271 | </pre> |
| 272 | </div> |
| 273 | |
| 274 | <div class="method"> |
| 275 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 276 | <pre>Updates an existing reservation resource. |
| 277 | |
| 278 | Args: |
| 279 | name: string, The resource name of the reservation, e.g., |
| 280 | "projects/*/locations/*/reservations/team1-prod". (required) |
| 281 | body: object, The request body. |
| 282 | The object takes the form of: |
| 283 | |
| 284 | { # A reservation is a mechanism used to guarantee slots to users. |
| 285 | "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of |
| 286 | # computational power in BigQuery, and serves as the unit of parallelism. |
| 287 | # Queries using this reservation might use more slots during runtime if |
| 288 | # ignore_idle_slots is set to false. |
| 289 | # If the new reservation's slot capacity exceed the parent's slot capacity or |
| 290 | # if total slot capacity of the new reservation and its siblings exceeds the |
| 291 | # parent's slot capacity, the request will fail with |
| 292 | # `google.rpc.Code.RESOURCE_EXHAUSTED`. |
| 293 | "name": "A String", # The resource name of the reservation, e.g., |
| 294 | # "projects/*/locations/*/reservations/team1-prod". |
| 295 | "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other |
| 296 | # reservations within the same admin project. If true, a query using this |
| 297 | # reservation will execute with the slot capacity specified above at most. |
| 298 | } |
| 299 | |
| 300 | updateMask: string, Standard field mask for the set of fields to be updated. |
| 301 | x__xgafv: string, V1 error format. |
| 302 | Allowed values |
| 303 | 1 - v1 error format |
| 304 | 2 - v2 error format |
| 305 | |
| 306 | Returns: |
| 307 | An object of the form: |
| 308 | |
| 309 | { # A reservation is a mechanism used to guarantee slots to users. |
| 310 | "slotCapacity": "A String", # Minimum slots available to this reservation. A slot is a unit of |
| 311 | # computational power in BigQuery, and serves as the unit of parallelism. |
| 312 | # Queries using this reservation might use more slots during runtime if |
| 313 | # ignore_idle_slots is set to false. |
| 314 | # If the new reservation's slot capacity exceed the parent's slot capacity or |
| 315 | # if total slot capacity of the new reservation and its siblings exceeds the |
| 316 | # parent's slot capacity, the request will fail with |
| 317 | # `google.rpc.Code.RESOURCE_EXHAUSTED`. |
| 318 | "name": "A String", # The resource name of the reservation, e.g., |
| 319 | # "projects/*/locations/*/reservations/team1-prod". |
| 320 | "ignoreIdleSlots": True or False, # If false, any query using this reservation will use idle slots from other |
| 321 | # reservations within the same admin project. If true, a query using this |
| 322 | # reservation will execute with the slot capacity specified above at most. |
| 323 | }</pre> |
| 324 | </div> |
| 325 | |
| 326 | </body></html> |