| 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_v1alpha2.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1alpha2.projects.html">projects</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.html">locations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="bigqueryreservation_v1alpha2.projects.locations.operations.html">operations()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the operations Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="bigqueryreservation_v1alpha2.projects.locations.reservationGrants.html">reservationGrants()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the reservationGrants Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="bigqueryreservation_v1alpha2.projects.locations.reservations.html">reservations()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the reservations Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#searchReservationGrants">searchReservationGrants(parent, query=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Look up grants for a specified resource for a particular region.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#searchReservationGrants_next">searchReservationGrants_next(previous_request, previous_response)</a></code></p> |
| 97 | <p class="firstline">Retrieves the next page of results.</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| 100 | <code class="details" id="searchReservationGrants">searchReservationGrants(parent, query=None, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 101 | <pre>Look up grants for a specified resource for a particular region. |
| 102 | If the request is about a project: |
| 103 | 1) Grants created on the project will be returned if they exist. |
| 104 | 2) Otherwise grants created on the closest ancestor will be returned. |
| 105 | 3) Grants for different JobTypes will all be returned. |
| 106 | Same logic applies if the request is about a folder. |
| 107 | If the request is about an organization, then grants created on the |
| 108 | organization will be returned (organization doesn't have ancestors). |
| 109 | Comparing to ListReservationGrants, there are two behavior |
| 110 | differences: |
| 111 | 1) permission on the grantee will be verified in this API. |
| 112 | 2) Hierarchy lookup (project->folder->organization) happens in this API. |
| 113 | |
| 114 | Args: |
| 115 | parent: string, The parent resource name (containing project and location), which owns the |
| 116 | grants. e.g.: |
| 117 | "projects/myproject/locations/us-central1". (required) |
| 118 | query: string, Please specify resource name as grantee in the query. |
| 119 | e.g., "grantee=projects/myproject" |
| 120 | "grantee=folders/123" |
| 121 | "grantee=organizations/456" |
| 122 | pageToken: string, The next_page_token value returned from a previous List request, if any. |
| 123 | pageSize: integer, The maximum number of items to return. |
| 124 | x__xgafv: string, V1 error format. |
| 125 | Allowed values |
| 126 | 1 - v1 error format |
| 127 | 2 - v2 error format |
| 128 | |
| 129 | Returns: |
| 130 | An object of the form: |
| 131 | |
| 132 | { # The response for ReservationService.SearchReservationGrants. |
| 133 | "reservationGrants": [ # List of reservation grants visible to the user. |
| 134 | { # A ReservationGrant allows a project to submit jobs |
| 135 | # of a certain type using slots from the specified reservation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 136 | "jobType": "A String", # Which type of jobs will use the reservation. |
| 137 | "state": "A String", # Output only. State of the ReservationGrant. |
| 138 | "name": "A String", # Output only. Name of the resource. E.g.: |
| 139 | # projects/myproject/locations/eu/reservationGrants/123. |
| 140 | "reservation": "A String", # Resource name of the reservation. |
| 141 | # E.g., projects/myproject/locations/eu/reservations/my_reservation. |
| 142 | # This reservation must be in the same location as the grant. |
| 143 | # This reservation should belong to the same parent project. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 144 | "grantee": "A String", # The resource which will use the reservation. E.g. |
| 145 | # projects/myproject, folders/123, organizations/456. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 146 | }, |
| 147 | ], |
| 148 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 149 | # more results in the list. |
| 150 | }</pre> |
| 151 | </div> |
| 152 | |
| 153 | <div class="method"> |
| 154 | <code class="details" id="searchReservationGrants_next">searchReservationGrants_next(previous_request, previous_response)</code> |
| 155 | <pre>Retrieves the next page of results. |
| 156 | |
| 157 | Args: |
| 158 | previous_request: The request for the previous page. (required) |
| 159 | previous_response: The response from the request for the previous page. (required) |
| 160 | |
| 161 | Returns: |
| 162 | A request object that you can call 'execute()' on to request the next |
| 163 | page. Returns None if there are no more items in the collection. |
| 164 | </pre> |
| 165 | </div> |
| 166 | |
| 167 | </body></html> |