| <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_v1alpha2.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1alpha2.projects.html">projects</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.html">locations</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.reservationGrants.html">reservationGrants</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a reservation grant. No expansion will happen.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists reservation grants.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have |
| 'bigquery.admin' permissions on the project using the reservation |
| and the project that owns this reservation. |
| Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the grant |
| does not match location of the reservation. |
| |
| Args: |
| parent: string, The parent resource name of the reservation grant |
| E.g.: projects/myproject/location/eu. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A ReservationGrant allows a project to submit jobs |
| # of a certain type using slots from the specified reservation. |
| "grantee": "A String", # The resource which will use the reservation. E.g. |
| # projects/myproject, folders/123, organizations/456. |
| "state": "A String", # Output only. State of the ReservationGrant. |
| "jobType": "A String", # Which type of jobs will use the reservation. |
| "reservation": "A String", # Resource name of the reservation. |
| # E.g., projects/myproject/locations/eu/reservations/my_reservation. |
| # This reservation must be in the same location as the grant. |
| # This reservation should belong to the same parent project. |
| "name": "A String", # Output only. Name of the resource. E.g.: |
| # projects/myproject/locations/eu/reservationGrants/123. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A ReservationGrant allows a project to submit jobs |
| # of a certain type using slots from the specified reservation. |
| "grantee": "A String", # The resource which will use the reservation. E.g. |
| # projects/myproject, folders/123, organizations/456. |
| "state": "A String", # Output only. State of the ReservationGrant. |
| "jobType": "A String", # Which type of jobs will use the reservation. |
| "reservation": "A String", # Resource name of the reservation. |
| # E.g., projects/myproject/locations/eu/reservations/my_reservation. |
| # This reservation must be in the same location as the grant. |
| # This reservation should belong to the same parent project. |
| "name": "A String", # Output only. Name of the resource. E.g.: |
| # projects/myproject/locations/eu/reservationGrants/123. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a reservation grant. No expansion will happen. |
| E.g: |
| organizationA contains project1 and project2. Reservation res1 exists. |
| CreateReservationGrant was invoked previously and following grants were |
| created explicitly: |
| <organizationA, res1> |
| <project1, res1> |
| Then deletion of <organizationA, res1> won't affect <project1, res1>. After |
| deletion of <organizationA, res1>, queries from project1 will still use |
| res1, while queries from project2 will use on-demand mode. |
| |
| Args: |
| name: string, Name of the resource, e.g.: |
| projects/myproject/locations/eu/reservationGrants/123 (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| <pre>Lists reservation grants. |
| Only explicitly created grants will be returned. E.g: |
| organizationA contains project1 and project2. Reservation res1 exists. |
| CreateReservationGrant was invoked previously and following grants were |
| created explicitly: |
| <organizationA, res1> |
| <project1, res1> |
| Then this API will just return the above two grants for reservation res1, |
| and no expansion/merge will happen. |
| |
| Args: |
| parent: string, The parent resource name e.g.: projects/myproject/location/eu. (required) |
| pageToken: string, The next_page_token value returned from a previous List request, if any. |
| pageSize: integer, The maximum number of items to return. |
| 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.ListReservationGrants. |
| "reservationGrants": [ # List of reservation grants visible to the user. |
| { # A ReservationGrant allows a project to submit jobs |
| # of a certain type using slots from the specified reservation. |
| "grantee": "A String", # The resource which will use the reservation. E.g. |
| # projects/myproject, folders/123, organizations/456. |
| "state": "A String", # Output only. State of the ReservationGrant. |
| "jobType": "A String", # Which type of jobs will use the reservation. |
| "reservation": "A String", # Resource name of the reservation. |
| # E.g., projects/myproject/locations/eu/reservations/my_reservation. |
| # This reservation must be in the same location as the grant. |
| # This reservation should belong to the same parent project. |
| "name": "A String", # Output only. Name of the resource. E.g.: |
| # projects/myproject/locations/eu/reservationGrants/123. |
| }, |
| ], |
| "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="list_next">list_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> |
| |
| </body></html> |
