Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / bigqueryreservation_v1alpha2.projects.locations.reservations.slotPools.html
blob: 8983040e33db9c63f9020160f958513107d6d280 [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.reservations.html">reservations</a> . <a href="bigqueryreservation_v1alpha2.projects.locations.reservations.slotPools.html">slotPools</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a slot pool. Attempting to delete slot pool before its</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Returns information about the slot pool.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]85<p class="firstline">Lists all the slot pools for the reservation.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
92 <pre>Deletes a slot pool. Attempting to delete slot pool before its
93commitment_end_time will fail with the error code
94`google.rpc.Code.FAILED_PRECONDITION`.
95
96Args:
97 name: string, Resource name of the slot pool to delete. E.g.,
98 projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123 (required)
99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104Returns:
105 An object of the form:
106
107 { # A generic empty message that you can re-use to avoid defining duplicated
108 # empty messages in your APIs. A typical example is to use it as the request
109 # or the response type of an API method. For instance:
110 #
111 # service Foo {
112 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
113 # }
114 #
115 # The JSON representation for `Empty` is empty JSON object `{}`.
116 }</pre>
117</div>
118
119<div class="method">
120 <code class="details" id="get">get(name, x__xgafv=None)</code>
121 <pre>Returns information about the slot pool.
122
123Args:
124 name: string, Resource name of the slot pool to retrieve. E.g.,
125 projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123 (required)
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131Returns:
132 An object of the form:
133
134 { # Slot pool is a way to purchase slots with some minimum committed period of
135 # usage. Slot pool is immutable and cannot be deleted until the end of the
136 # commitment period. After the end of the commitment period, slots are still
137 # available but can be freely removed any time. Annual commitments will
138 # automatically be downgraded to monthly after the commitment ends.
139 #
140 # A slot pool resource exists as a child resource of a top-level reservation.
141 # Sum of all the ACTIVE pools slot_count is always equal to the reservation
142 # slot_capacity.
143 &quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED slot pool, provides the reason of failure.
144 # different programming environments, including REST APIs and RPC APIs. It is
145 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
146 # three pieces of data: error code, error message, and error details.
147 #
148 # You can find out more about this error model and how to work with it in the
149 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
151 # message types for APIs to use.
152 {
153 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
154 },
155 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]156 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
157 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
158 # user-facing error message should be localized and sent in the
159 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]161 &quot;plan&quot;: &quot;A String&quot;, # Slot pool commitment plan.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 &quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the commitment period. Slot pool cannot be
163 # removed before commitment_end_time. It is applicable only for ACTIVE slot
164 # pools and is computed as a combination of the plan and the time when the
165 # slot pool became ACTIVE.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the slot pool, e.g.,
167 # projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]168 &quot;state&quot;: &quot;A String&quot;, # Output only.
169 &quot;slotCount&quot;: &quot;A String&quot;, # Number of slots in this pool.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 }</pre>
171</div>
172
173<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]174 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 <pre>Lists all the slot pools for the reservation.
176
177Args:
178 parent: string, Resource name of the parent reservation. Only top-level reservations can
179have slot pools. E.g.,
180 projects/myproject/locations/us-central1/reservations/my_reservation (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 pageSize: integer, The maximum number of items to return.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]182 pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 x__xgafv: string, V1 error format.
184 Allowed values
185 1 - v1 error format
186 2 - v2 error format
187
188Returns:
189 An object of the form:
190
191 { # The response for ReservationService.ListSlotPools.
192 &quot;slotPools&quot;: [ # List of slot pools visible to the user.
193 { # Slot pool is a way to purchase slots with some minimum committed period of
194 # usage. Slot pool is immutable and cannot be deleted until the end of the
195 # commitment period. After the end of the commitment period, slots are still
196 # available but can be freely removed any time. Annual commitments will
197 # automatically be downgraded to monthly after the commitment ends.
198 #
199 # A slot pool resource exists as a child resource of a top-level reservation.
200 # Sum of all the ACTIVE pools slot_count is always equal to the reservation
201 # slot_capacity.
202 &quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED slot pool, provides the reason of failure.
203 # different programming environments, including REST APIs and RPC APIs. It is
204 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
205 # three pieces of data: error code, error message, and error details.
206 #
207 # You can find out more about this error model and how to work with it in the
208 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]209 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
210 # message types for APIs to use.
211 {
212 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
213 },
214 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]215 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
216 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
217 # user-facing error message should be localized and sent in the
218 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]219 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]220 &quot;plan&quot;: &quot;A String&quot;, # Slot pool commitment plan.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 &quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the commitment period. Slot pool cannot be
222 # removed before commitment_end_time. It is applicable only for ACTIVE slot
223 # pools and is computed as a combination of the plan and the time when the
224 # slot pool became ACTIVE.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]225 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the slot pool, e.g.,
226 # projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]227 &quot;state&quot;: &quot;A String&quot;, # Output only.
228 &quot;slotCount&quot;: &quot;A String&quot;, # Number of slots in this pool.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 },
230 ],
231 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
232 # more results in the list.
233 }</pre>
234</div>
235
236<div class="method">
237 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
238 <pre>Retrieves the next page of results.
239
240Args:
241 previous_request: The request for the previous page. (required)
242 previous_response: The response from the request for the previous page. (required)
243
244Returns:
245 A request object that you can call &#x27;execute()&#x27; on to request the next
246 page. Returns None if there are no more items in the collection.
247 </pre>
248</div>
249
250</body></html>