Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0bf565cdd7eac073130c7d9700285524a0efd1a3 / . / docs / dyn / bigqueryreservation_v1alpha2.projects.locations.reservationGrants.html
blob: ffcfcd9ea8de71a7e99e5a29649ab79fb6134923 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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> . <a href="bigqueryreservation_v1alpha2.projects.locations.reservationGrants.html">reservationGrants</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">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.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">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: Then deletion of won't affect . After deletion of , queries from project1 will still use res1, while queries from project2 will use on-demand mode.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]87 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">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: Then this API will just return the above two grants for reservation res1, and no expansion/merge will happen.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]99 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <pre>Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have &#x27;bigquery.admin&#x27; 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 parent: string, The parent resource name of the reservation grant E.g.: projects/myproject/location/eu. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 body: object, The request body.
105 The object takes the form of:
106
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107{ # A ReservationGrant allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]108 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]109 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: projects/myproject/locations/eu/reservationGrants/123.
110 &quot;grantee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]111 &quot;reservation&quot;: &quot;A String&quot;, # 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.
112 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the ReservationGrant.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113}
114
115 x__xgafv: string, V1 error format.
116 Allowed values
117 1 - v1 error format
118 2 - v2 error format
119
120Returns:
121 An object of the form:
122
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]123 { # A ReservationGrant allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]124 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]125 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: projects/myproject/locations/eu/reservationGrants/123.
126 &quot;grantee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]127 &quot;reservation&quot;: &quot;A String&quot;, # 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.
128 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the ReservationGrant.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 }</pre>
130</div>
131
132<div class="method">
133 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]134 <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: Then deletion of won&#x27;t affect . After deletion of , queries from project1 will still use res1, while queries from project2 will use on-demand mode.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135
136Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]137 name: string, Name of the resource, e.g.: projects/myproject/locations/eu/reservationGrants/123 (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 x__xgafv: string, V1 error format.
139 Allowed values
140 1 - v1 error format
141 2 - v2 error format
142
143Returns:
144 An object of the form:
145
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]146 { # 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 `{}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 }</pre>
148</div>
149
150<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]151 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]152 <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: Then this API will just return the above two grants for reservation res1, and no expansion/merge will happen.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153
154Args:
155 parent: string, The parent resource name e.g.: projects/myproject/location/eu. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]156 pageToken: string, The next_page_token value returned from a previous List request, if any.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]157 pageSize: integer, The maximum number of items to return.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163Returns:
164 An object of the form:
165
166 { # The response for ReservationService.ListReservationGrants.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]167 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 &quot;reservationGrants&quot;: [ # List of reservation grants visible to the user.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]169 { # A ReservationGrant allows a project to submit jobs of a certain type using slots from the specified reservation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]170 &quot;jobType&quot;: &quot;A String&quot;, # Which type of jobs will use the reservation.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]171 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the resource. E.g.: projects/myproject/locations/eu/reservationGrants/123.
172 &quot;grantee&quot;: &quot;A String&quot;, # The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]173 &quot;reservation&quot;: &quot;A String&quot;, # 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.
174 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the ReservationGrant.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 },
176 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
182 <pre>Retrieves the next page of results.
183
184Args:
185 previous_request: The request for the previous page. (required)
186 previous_response: The response from the request for the previous page. (required)
187
188Returns:
189 A request object that you can call &#x27;execute()&#x27; on to request the next
190 page. Returns None if there are no more items in the collection.
191 </pre>
192</div>
193
194</body></html>