• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="pubsub_v1.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1.projects.html">projects</a> . <a href="pubsub_v1.projects.topics.html">topics</a> . <a href="pubsub_v1.projects.topics.snapshots.html">snapshots</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(topic, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Lists the names of the snapshots on this topic. Snapshots are used in</p>
80<p class="toc_element">
81  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="list">list(topic, pageSize=None, pageToken=None, x__xgafv=None)</code>
86  <pre>Lists the names of the snapshots on this topic. Snapshots are used in
87<a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
88operations, which allow
89you to manage message acknowledgments in bulk. That is, you can set the
90acknowledgment state of messages in an existing subscription to the state
91captured by a snapshot.
92
93Args:
94  topic: string, The name of the topic that snapshots are attached to.
95Format is `projects/{project}/topics/{topic}`. (required)
96  pageSize: integer, Maximum number of snapshot names to return.
97  pageToken: string, The value returned by the last `ListTopicSnapshotsResponse`; indicates
98that this is a continuation of a prior `ListTopicSnapshots` call, and
99that the system should return the next page of data.
100  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 the `ListTopicSnapshots` method.
109    "nextPageToken": "A String", # If not empty, indicates that there may be more snapshots that match
110        # the request; this value should be passed in a new
111        # `ListTopicSnapshotsRequest` to get more snapshots.
112    "snapshots": [ # The names of the snapshots that match the request.
113      "A String",
114    ],
115  }</pre>
116</div>
117
118<div class="method">
119    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
120  <pre>Retrieves the next page of results.
121
122Args:
123  previous_request: The request for the previous page. (required)
124  previous_response: The response from the request for the previous page. (required)
125
126Returns:
127  A request object that you can call 'execute()' on to request the next
128  page. Returns None if there are no more items in the collection.
129    </pre>
130</div>
131
132</body></html>