Class ProjectsResource.SnapshotsResource.ListRequest

Lists the existing snapshots. 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
object
ClientServiceRequest
ClientServiceRequest<ListSnapshotsResponse>
PubsubBaseServiceRequest<ListSnapshotsResponse>
ProjectsResource.SnapshotsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Pubsub.v1
Assembly: Google.Apis.Pubsub.v1.dll
Syntax
public class ProjectsResource.SnapshotsResource.ListRequest : PubsubBaseServiceRequest<ListSnapshotsResponse>, IClientServiceRequest<ListSnapshotsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string project)
Parameters
Type Name Description
IClientService service
string project

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 snapshots 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 ListSnapshotsResponse; indicates that this is a continuation of a prior ListSnapshots 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

Project

Required. The name of the project in which to list snapshots. Format is projects/{project-id}.

Declaration
[RequestParameter("project", RequestParameterType.Path)]
public virtual string Project { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements