| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html">capacityCommitments()</a></code> |
| </p> |
| <p class="firstline">Returns the capacityCommitments Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="bigqueryreservation_v1beta1.projects.locations.reservations.html">reservations()</a></code> |
| </p> |
| <p class="firstline">Returns the reservations Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#getBiReservation">getBiReservation(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a BI reservation.</p> |
| <p class="toc_element"> |
| <code><a href="#searchAssignments">searchAssignments(parent, pageSize=None, query=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Looks up assignments for a specified resource for a particular region.</p> |
| <p class="toc_element"> |
| <code><a href="#searchAssignments_next">searchAssignments_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a BI reservation.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="getBiReservation">getBiReservation(name, x__xgafv=None)</code> |
| <pre>Retrieves a BI reservation. |
| |
| Args: |
| name: string, Required. Name of the requested reservation, for example: |
| `projects/{project_id}/locations/{location_id}/bireservation` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a BI Reservation. |
| "name": "A String", # The resource name of the singleton BI reservation. |
| # Reservation names have the form |
| # `projects/{project_id}/locations/{location_id}/bireservation`. |
| "size": "A String", # Size of a reservation, in bytes. |
| "updateTime": "A String", # Output only. The last update timestamp of a reservation. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchAssignments">searchAssignments(parent, pageSize=None, query=None, pageToken=None, x__xgafv=None)</code> |
| <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. |
| |
| Args: |
| parent: string, Required. The resource name of the admin project(containing project and location), |
| e.g.: |
| `projects/myproject/locations/US`. (required) |
| pageSize: integer, The maximum number of items to return. |
| query: string, Please specify resource name as assignee in the query. |
| |
| Examples: |
| |
| * `assignee=projects/myproject` |
| * `assignee=folders/123` |
| * `assignee=organizations/456` |
| pageToken: string, The next_page_token value returned from a previous List request, if any. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response for ReservationService.SearchAssignments. |
| "assignments": [ # List of assignments visible to the user. |
| { # A Assignment allows a project to submit jobs |
| # of a certain type using slots from the specified reservation. |
| "jobType": "A String", # Which type of jobs will use the reservation. |
| "name": "A String", # Output only. Name of the resource. E.g.: |
| # `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. |
| "assignee": "A String", # The resource which will use the reservation. E.g. |
| # `projects/myproject`, `folders/123`, or `organizations/456`. |
| "state": "A String", # Output only. State of the assignment. |
| }, |
| ], |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| # more results in the list. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchAssignments_next">searchAssignments_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <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. |
| |
| Args: |
| name: string, The resource name of the singleton BI reservation. |
| Reservation names have the form |
| `projects/{project_id}/locations/{location_id}/bireservation`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a BI Reservation. |
| "name": "A String", # The resource name of the singleton BI reservation. |
| # Reservation names have the form |
| # `projects/{project_id}/locations/{location_id}/bireservation`. |
| "size": "A String", # Size of a reservation, in bytes. |
| "updateTime": "A String", # Output only. The last update timestamp of a reservation. |
| } |
| |
| updateMask: string, A list of fields to be updated in this request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a BI Reservation. |
| "name": "A String", # The resource name of the singleton BI reservation. |
| # Reservation names have the form |
| # `projects/{project_id}/locations/{location_id}/bireservation`. |
| "size": "A String", # Size of a reservation, in bytes. |
| "updateTime": "A String", # Output only. The last update timestamp of a reservation. |
| }</pre> |
| </div> |
| |
| </body></html> |
