Skip to content

Commit fc27fe7

Browse files
feat(pubsublite): update the api
#### pubsublite:v1 The following keys were added: - resources.admin.resources.projects.resources.locations.resources.reservations.methods.create (Total Keys: 14) - resources.admin.resources.projects.resources.locations.resources.reservations.methods.delete (Total Keys: 11) - resources.admin.resources.projects.resources.locations.resources.reservations.methods.get (Total Keys: 11) - resources.admin.resources.projects.resources.locations.resources.reservations.methods.list (Total Keys: 16) - resources.admin.resources.projects.resources.locations.resources.reservations.methods.patch (Total Keys: 15) - resources.admin.resources.projects.resources.locations.resources.reservations.resources.topics.methods.list (Total Keys: 16) - schemas.ListReservationTopicsResponse (Total Keys: 5) - schemas.ListReservationsResponse (Total Keys: 5) - schemas.Reservation (Total Keys: 8) - schemas.Topic.properties.reservationConfig.$ref (Total Keys: 1)
1 parent 4511cbc commit fc27fe7

5 files changed

+666
-1
lines changed

docs/dyn/pubsublite_v1.admin.projects.locations.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the operations Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="pubsublite_v1.admin.projects.locations.reservations.html">reservations()</a></code>
84+
</p>
85+
<p class="firstline">Returns the reservations Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="pubsublite_v1.admin.projects.locations.subscriptions.html">subscriptions()</a></code>
8489
</p>
Lines changed: 246 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,246 @@
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="pubsublite_v1.html">Pub/Sub Lite API</a> . <a href="pubsublite_v1.admin.html">admin</a> . <a href="pubsublite_v1.admin.projects.html">projects</a> . <a href="pubsublite_v1.admin.projects.locations.html">locations</a> . <a href="pubsublite_v1.admin.projects.locations.reservations.html">reservations</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="pubsublite_v1.admin.projects.locations.reservations.topics.html">topics()</a></code>
79+
</p>
80+
<p class="firstline">Returns the topics Resource.</p>
81+
82+
<p class="toc_element">
83+
<code><a href="#close">close()</a></code></p>
84+
<p class="firstline">Close httplib2 connections.</p>
85+
<p class="toc_element">
86+
<code><a href="#create">create(parent, body=None, reservationId=None, x__xgafv=None)</a></code></p>
87+
<p class="firstline">Creates a new reservation.</p>
88+
<p class="toc_element">
89+
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90+
<p class="firstline">Deletes the specified reservation.</p>
91+
<p class="toc_element">
92+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93+
<p class="firstline">Returns the reservation configuration.</p>
94+
<p class="toc_element">
95+
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
96+
<p class="firstline">Returns the list of reservations for the given project.</p>
97+
<p class="toc_element">
98+
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99+
<p class="firstline">Retrieves the next page of results.</p>
100+
<p class="toc_element">
101+
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
102+
<p class="firstline">Updates properties of the specified reservation.</p>
103+
<h3>Method Details</h3>
104+
<div class="method">
105+
<code class="details" id="close">close()</code>
106+
<pre>Close httplib2 connections.</pre>
107+
</div>
108+
109+
<div class="method">
110+
<code class="details" id="create">create(parent, body=None, reservationId=None, x__xgafv=None)</code>
111+
<pre>Creates a new reservation.
112+
113+
Args:
114+
parent: string, Required. The parent location in which to create the reservation. Structured like `projects/{project_number}/locations/{location}`. (required)
115+
body: object, The request body.
116+
The object takes the form of:
117+
118+
{ # Metadata about a reservation resource.
119+
&quot;name&quot;: &quot;A String&quot;, # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
120+
&quot;throughputCapacity&quot;: &quot;A String&quot;, # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
121+
}
122+
123+
reservationId: string, Required. The ID to use for the reservation, which will become the final component of the reservation&#x27;s name. This value is structured like: `my-reservation-name`.
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+
{ # Metadata about a reservation resource.
133+
&quot;name&quot;: &quot;A String&quot;, # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
134+
&quot;throughputCapacity&quot;: &quot;A String&quot;, # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
135+
}</pre>
136+
</div>
137+
138+
<div class="method">
139+
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
140+
<pre>Deletes the specified reservation.
141+
142+
Args:
143+
name: string, Required. The name of the reservation to delete. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} (required)
144+
x__xgafv: string, V1 error format.
145+
Allowed values
146+
1 - v1 error format
147+
2 - v2 error format
148+
149+
Returns:
150+
An object of the form:
151+
152+
{ # 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 `{}`.
153+
}</pre>
154+
</div>
155+
156+
<div class="method">
157+
<code class="details" id="get">get(name, x__xgafv=None)</code>
158+
<pre>Returns the reservation configuration.
159+
160+
Args:
161+
name: string, Required. The name of the reservation whose configuration to return. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} (required)
162+
x__xgafv: string, V1 error format.
163+
Allowed values
164+
1 - v1 error format
165+
2 - v2 error format
166+
167+
Returns:
168+
An object of the form:
169+
170+
{ # Metadata about a reservation resource.
171+
&quot;name&quot;: &quot;A String&quot;, # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
172+
&quot;throughputCapacity&quot;: &quot;A String&quot;, # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
173+
}</pre>
174+
</div>
175+
176+
<div class="method">
177+
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
178+
<pre>Returns the list of reservations for the given project.
179+
180+
Args:
181+
parent: string, Required. The parent whose reservations are to be listed. Structured like `projects/{project_number}/locations/{location}`. (required)
182+
pageSize: integer, The maximum number of reservations to return. The service may return fewer than this value. If unset or zero, all reservations for the parent will be returned.
183+
pageToken: string, A page token, received from a previous `ListReservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReservations` must match the call that provided the page token.
184+
x__xgafv: string, V1 error format.
185+
Allowed values
186+
1 - v1 error format
187+
2 - v2 error format
188+
189+
Returns:
190+
An object of the form:
191+
192+
{ # Response for ListReservations.
193+
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
194+
&quot;reservations&quot;: [ # The list of reservation in the requested parent. The order of the reservations is unspecified.
195+
{ # Metadata about a reservation resource.
196+
&quot;name&quot;: &quot;A String&quot;, # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
197+
&quot;throughputCapacity&quot;: &quot;A String&quot;, # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
198+
},
199+
],
200+
}</pre>
201+
</div>
202+
203+
<div class="method">
204+
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
205+
<pre>Retrieves the next page of results.
206+
207+
Args:
208+
previous_request: The request for the previous page. (required)
209+
previous_response: The response from the request for the previous page. (required)
210+
211+
Returns:
212+
A request object that you can call &#x27;execute()&#x27; on to request the next
213+
page. Returns None if there are no more items in the collection.
214+
</pre>
215+
</div>
216+
217+
<div class="method">
218+
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
219+
<pre>Updates properties of the specified reservation.
220+
221+
Args:
222+
name: string, The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} (required)
223+
body: object, The request body.
224+
The object takes the form of:
225+
226+
{ # Metadata about a reservation resource.
227+
&quot;name&quot;: &quot;A String&quot;, # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
228+
&quot;throughputCapacity&quot;: &quot;A String&quot;, # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
229+
}
230+
231+
updateMask: string, Required. A mask specifying the reservation fields to change.
232+
x__xgafv: string, V1 error format.
233+
Allowed values
234+
1 - v1 error format
235+
2 - v2 error format
236+
237+
Returns:
238+
An object of the form:
239+
240+
{ # Metadata about a reservation resource.
241+
&quot;name&quot;: &quot;A String&quot;, # The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
242+
&quot;throughputCapacity&quot;: &quot;A String&quot;, # The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
243+
}</pre>
244+
</div>
245+
246+
</body></html>
Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
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="pubsublite_v1.html">Pub/Sub Lite API</a> . <a href="pubsublite_v1.admin.html">admin</a> . <a href="pubsublite_v1.admin.projects.html">projects</a> . <a href="pubsublite_v1.admin.projects.locations.html">locations</a> . <a href="pubsublite_v1.admin.projects.locations.reservations.html">reservations</a> . <a href="pubsublite_v1.admin.projects.locations.reservations.topics.html">topics</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Lists the topics attached to the specified reservation.</p>
83+
<p class="toc_element">
84+
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85+
<p class="firstline">Retrieves the next page of results.</p>
86+
<h3>Method Details</h3>
87+
<div class="method">
88+
<code class="details" id="close">close()</code>
89+
<pre>Close httplib2 connections.</pre>
90+
</div>
91+
92+
<div class="method">
93+
<code class="details" id="list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</code>
94+
<pre>Lists the topics attached to the specified reservation.
95+
96+
Args:
97+
name: string, Required. The name of the reservation whose topics to list. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} (required)
98+
pageSize: integer, The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the given reservation will be returned.
99+
pageToken: string, A page token, received from a previous `ListReservationTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReservationTopics` must match the call that provided the page token.
100+
x__xgafv: string, V1 error format.
101+
Allowed values
102+
1 - v1 error format
103+
2 - v2 error format
104+
105+
Returns:
106+
An object of the form:
107+
108+
{ # Response for ListReservationTopics.
109+
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
110+
&quot;topics&quot;: [ # The names of topics attached to the reservation. The order of the topics is unspecified.
111+
&quot;A String&quot;,
112+
],
113+
}</pre>
114+
</div>
115+
116+
<div class="method">
117+
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
118+
<pre>Retrieves the next page of results.
119+
120+
Args:
121+
previous_request: The request for the previous page. (required)
122+
previous_response: The response from the request for the previous page. (required)
123+
124+
Returns:
125+
A request object that you can call &#x27;execute()&#x27; on to request the next
126+
page. Returns None if there are no more items in the collection.
127+
</pre>
128+
</div>
129+
130+
</body></html>

0 commit comments

Comments
 (0)