Class ProjectsResource.TopicsResource.SnapshotsResource.ListRequest
Lists the names of the snapshots on this topic. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
Inheritance
Inherited Members
Namespace: Google.Apis.Pubsub.v1
Assembly: Google.Apis.Pubsub.v1.dll
Syntax
public class ProjectsResource.TopicsResource.SnapshotsResource.ListRequest : PubsubBaseServiceRequest<ListTopicSnapshotsResponse>, IClientServiceRequest<ListTopicSnapshotsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string topic)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | topic |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
PageSize
Optional. Maximum number of snapshot names to return.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
Optional. The value returned by the last ListTopicSnapshotsResponse
; indicates that this is a
continuation of a prior ListTopicSnapshots
call, and that the system should return the next
page of data.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Topic
Required. The name of the topic that snapshots are attached to. Format is
projects/{project}/topics/{topic}
.
Declaration
[RequestParameter("topic", RequestParameterType.Path)]
public virtual string Topic { get; }
Property Value
Type | Description |
---|---|
string |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()