Show / Hide Table of Contents

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
object
ClientServiceRequest
ClientServiceRequest<ListTopicSnapshotsResponse>
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>
ProjectsResource.TopicsResource.SnapshotsResource.ListRequest
Implements
IClientServiceRequest<ListTopicSnapshotsResponse>
IClientServiceRequest
Inherited Members
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.Xgafv
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.AccessToken
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.Alt
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.Callback
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.Fields
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.Key
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.OauthToken
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.PrettyPrint
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.QuotaUser
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.UploadType
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.UploadProtocol
ClientServiceRequest<ListTopicSnapshotsResponse>.Execute()
ClientServiceRequest<ListTopicSnapshotsResponse>.ExecuteAsStream()
ClientServiceRequest<ListTopicSnapshotsResponse>.ExecuteAsync()
ClientServiceRequest<ListTopicSnapshotsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListTopicSnapshotsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListTopicSnapshotsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListTopicSnapshotsResponse>.CreateRequest(bool?)
ClientServiceRequest<ListTopicSnapshotsResponse>.GenerateRequestUri()
ClientServiceRequest<ListTopicSnapshotsResponse>.GetBody()
ClientServiceRequest<ListTopicSnapshotsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListTopicSnapshotsResponse>.ETagAction
ClientServiceRequest<ListTopicSnapshotsResponse>.ModifyRequest
ClientServiceRequest<ListTopicSnapshotsResponse>.ValidateParameters
ClientServiceRequest<ListTopicSnapshotsResponse>.ApiVersion
ClientServiceRequest<ListTopicSnapshotsResponse>.RequestParameters
ClientServiceRequest<ListTopicSnapshotsResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
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
ClientServiceRequest<ListTopicSnapshotsResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListTopicSnapshotsResponse>.MethodName

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
ClientServiceRequest<ListTopicSnapshotsResponse>.RestPath

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()
Overrides
PubsubBaseServiceRequest<ListTopicSnapshotsResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX