blob: 1b83b1faed4a414e60509e7eb6a48780bf0b4f67 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001<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="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.topics.html">topics</a> . <a href="pubsublite_v1.admin.projects.locations.topics.subscriptions.html">subscriptions</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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080081 <code><a href="#list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">Lists the subscriptions attached to the specified topic.</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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080093 <code class="details" id="list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <pre>Lists the subscriptions attached to the specified topic.
95
96Args:
97 name: string, Required. The name of the topic whose subscriptions to list. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080098 pageSize: integer, The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080099 pageToken: string, A page token, received from a previous `ListTopicSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopicSubscriptions` must match the call that provided the page token.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100 x__xgafv: string, V1 error format.
101 Allowed values
102 1 - v1 error format
103 2 - v2 error format
104
105Returns:
106 An object of the form:
107
108 { # Response for ListTopicSubscriptions.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800109 &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;subscriptions&quot;: [ # The names of subscriptions attached to the topic. The order of the subscriptions is unspecified.
111 &quot;A String&quot;,
112 ],
113}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114</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
120Args:
121 previous_request: The request for the previous page. (required)
122 previous_response: The response from the request for the previous page. (required)
123
124Returns:
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>