Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / bigqueryreservation_v1alpha2.projects.locations.reservations.slotPools.html
blob: 2b0d1b0e7a67657d87b342d3cd91ce04d19bb29d [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">
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="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]82<p class="firstline">Deletes a slot pool. Attempting to delete slot pool before its commitment_end_time will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns information about the slot pool.</p>
86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]87 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]88<p class="firstline">Lists all the slot pools for the reservation.</p>
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="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]100 <pre>Deletes a slot pool. Attempting to delete slot pool before its commitment_end_time will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]103 name: string, Resource name of the slot pool to delete. E.g., projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123 (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109Returns:
110 An object of the form:
111
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]112 { # 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]113 }</pre>
114</div>
115
116<div class="method">
117 <code class="details" id="get">get(name, x__xgafv=None)</code>
118 <pre>Returns information about the slot pool.
119
120Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]121 name: string, Resource name of the slot pool to retrieve. E.g., projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123 (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]130 { # Slot pool is a way to purchase slots with some minimum committed period of usage. Slot pool is immutable and cannot be deleted until the end of the commitment period. After the end of the commitment period, slots are still available but can be freely removed any time. Annual commitments will automatically be downgraded to monthly after the commitment ends. A slot pool resource exists as a child resource of a top-level reservation. Sum of all the ACTIVE pools slot_count is always equal to the reservation slot_capacity.
131 &quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED slot pool, provides the reason of failure.
132 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
133 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
134 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 {
136 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
137 },
138 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]140 &quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the commitment period. Slot pool cannot be removed before commitment_end_time. It is applicable only for ACTIVE slot pools and is computed as a combination of the plan and the time when the slot pool became ACTIVE.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]141 &quot;state&quot;: &quot;A String&quot;, # Output only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]142 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the slot pool, e.g., projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]143 &quot;slotCount&quot;: &quot;A String&quot;, # Number of slots in this pool.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]144 &quot;plan&quot;: &quot;A String&quot;, # Slot pool commitment plan.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 }</pre>
146</div>
147
148<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]149 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 <pre>Lists all the slot pools for the reservation.
151
152Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]153 parent: string, Resource name of the parent reservation. Only top-level reservations can have slot pools. E.g., projects/myproject/locations/us-central1/reservations/my_reservation (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]154 pageToken: string, The next_page_token value returned from a previous List request, if any.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]155 pageSize: integer, The maximum number of items to return.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
160
161Returns:
162 An object of the form:
163
164 { # The response for ReservationService.ListSlotPools.
165 &quot;slotPools&quot;: [ # List of slot pools visible to the user.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]166 { # Slot pool is a way to purchase slots with some minimum committed period of usage. Slot pool is immutable and cannot be deleted until the end of the commitment period. After the end of the commitment period, slots are still available but can be freely removed any time. Annual commitments will automatically be downgraded to monthly after the commitment ends. A slot pool resource exists as a child resource of a top-level reservation. Sum of all the ACTIVE pools slot_count is always equal to the reservation slot_capacity.
167 &quot;failureStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. For FAILED slot pool, provides the reason of failure.
168 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
169 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
170 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]171 {
172 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
173 },
174 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]176 &quot;commitmentEndTime&quot;: &quot;A String&quot;, # Output only. The end of the commitment period. Slot pool cannot be removed before commitment_end_time. It is applicable only for ACTIVE slot pools and is computed as a combination of the plan and the time when the slot pool became ACTIVE.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]177 &quot;state&quot;: &quot;A String&quot;, # Output only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]178 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the slot pool, e.g., projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]179 &quot;slotCount&quot;: &quot;A String&quot;, # Number of slots in this pool.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]180 &quot;plan&quot;: &quot;A String&quot;, # Slot pool commitment plan.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 },
182 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]183 &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]184 }</pre>
185</div>
186
187<div class="method">
188 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
189 <pre>Retrieves the next page of results.
190
191Args:
192 previous_request: The request for the previous page. (required)
193 previous_response: The response from the request for the previous page. (required)
194
195Returns:
196 A request object that you can call &#x27;execute()&#x27; on to request the next
197 page. Returns None if there are no more items in the collection.
198 </pre>
199</div>
200
201</body></html>