Cloud Pub/Sub v1 API - Class Subscriber.SubscriberBase (3.10.0-beta01)

[BindServiceMethod(typeof(Subscriber), "BindService")]
public abstract class Subscriber.SubscriberBase

Reference documentation and code samples for the Cloud Pub/Sub v1 API class Subscriber.SubscriberBase.

Base class for server-side implementations of Subscriber

Inheritance

object > Subscriber.SubscriberBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Methods

Acknowledge(AcknowledgeRequest, ServerCallContext)

public virtual Task<Empty> Acknowledge(AcknowledgeRequest request, ServerCallContext context)

Acknowledges the messages associated with the ack_ids in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription.

Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

Parameters
Name	Description
`request`	`AcknowledgeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

CreateSnapshot(CreateSnapshotRequest, ServerCallContext)

public virtual Task<Snapshot> CreateSnapshot(CreateSnapshotRequest request, ServerCallContext context)

Creates a snapshot from the requested subscription. 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. If the snapshot already exists, returns ALREADY_EXISTS. If the requested subscription doesn't exist, returns NOT_FOUND. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then FAILED_PRECONDITION is returned. See also the Snapshot.expire_time field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the resource name format. The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.

Parameters
Name	Description
`request`	`CreateSnapshotRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSnapshot`	The response to send back to the client (wrapped by a task).

CreateSubscription(Subscription, ServerCallContext)

public virtual Task<Subscription> CreateSubscription(Subscription request, ServerCallContext context)

Creates a subscription to a given topic. See the resource name rules. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND.

If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Parameters
Name	Description
`request`	`Subscription` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSubscription`	The response to send back to the client (wrapped by a task).

DeleteSnapshot(DeleteSnapshotRequest, ServerCallContext)

public virtual Task<Empty> DeleteSnapshot(DeleteSnapshotRequest request, ServerCallContext context)

Removes an existing snapshot. 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. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

Parameters
Name	Description
`request`	`DeleteSnapshotRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteSubscription(DeleteSubscriptionRequest, ServerCallContext)

public virtual Task<Empty> DeleteSubscription(DeleteSubscriptionRequest request, ServerCallContext context)

Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.

Parameters
Name	Description
`request`	`DeleteSubscriptionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

GetSnapshot(GetSnapshotRequest, ServerCallContext)

public virtual Task<Snapshot> GetSnapshot(GetSnapshotRequest request, ServerCallContext context)

Gets the configuration details of a snapshot. 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.

Parameters
Name	Description
`request`	`GetSnapshotRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSnapshot`	The response to send back to the client (wrapped by a task).

GetSubscription(GetSubscriptionRequest, ServerCallContext)

public virtual Task<Subscription> GetSubscription(GetSubscriptionRequest request, ServerCallContext context)

Gets the configuration details of a subscription.

Parameters
Name	Description
`request`	`GetSubscriptionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSubscription`	The response to send back to the client (wrapped by a task).

ListSnapshots(ListSnapshotsRequest, ServerCallContext)

public virtual Task<ListSnapshotsResponse> ListSnapshots(ListSnapshotsRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`ListSnapshotsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListSnapshotsResponse`	The response to send back to the client (wrapped by a task).

ListSubscriptions(ListSubscriptionsRequest, ServerCallContext)

public virtual Task<ListSubscriptionsResponse> ListSubscriptions(ListSubscriptionsRequest request, ServerCallContext context)

Lists matching subscriptions.

Parameters
Name	Description
`request`	`ListSubscriptionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListSubscriptionsResponse`	The response to send back to the client (wrapped by a task).

ModifyAckDeadline(ModifyAckDeadlineRequest, ServerCallContext)

public virtual Task<Empty> ModifyAckDeadline(ModifyAckDeadlineRequest request, ServerCallContext context)

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level ackDeadlineSeconds used for subsequent messages.

Parameters
Name	Description
`request`	`ModifyAckDeadlineRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

ModifyPushConfig(ModifyPushConfigRequest, ServerCallContext)

public virtual Task<Empty> ModifyPushConfig(ModifyPushConfigRequest request, ServerCallContext context)

Modifies the PushConfig for a specified subscription.

This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.

Parameters
Name	Description
`request`	`ModifyPushConfigRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

Pull(PullRequest, ServerCallContext)

public virtual Task<PullResponse> Pull(PullRequest request, ServerCallContext context)

Pulls messages from the server.

Parameters
Name	Description
`request`	`PullRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPullResponse`	The response to send back to the client (wrapped by a task).

Seek(SeekRequest, ServerCallContext)

public virtual Task<SeekResponse> Seek(SeekRequest request, ServerCallContext context)

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. 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. Note that both the subscription and the snapshot must be on the same topic.

Parameters
Name	Description
`request`	`SeekRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSeekResponse`	The response to send back to the client (wrapped by a task).

StreamingPull(IAsyncStreamReader<StreamingPullRequest>, IServerStreamWriter<StreamingPullResponse>, ServerCallContext)

public virtual Task StreamingPull(IAsyncStreamReader<StreamingPullRequest> requestStream, IServerStreamWriter<StreamingPullResponse> responseStream, ServerCallContext context)

Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status UNAVAILABLE to reassign server-side resources, in which case, the client should re-establish the stream. Flow control can be achieved by configuring the underlying RPC channel.

Parameters
Name	Description
`requestStream`	`IAsyncStreamReaderStreamingPullRequest` Used for reading requests from the client.
`responseStream`	`IServerStreamWriterStreamingPullResponse` Used for sending responses back to the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task`	A task indicating completion of the handler.

UpdateSnapshot(UpdateSnapshotRequest, ServerCallContext)

public virtual Task<Snapshot> UpdateSnapshot(UpdateSnapshotRequest request, ServerCallContext context)

Updates an existing snapshot by updating the fields specified in the update mask. 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.

Parameters
Name	Description
`request`	`UpdateSnapshotRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSnapshot`	The response to send back to the client (wrapped by a task).

UpdateSubscription(UpdateSubscriptionRequest, ServerCallContext)

public virtual Task<Subscription> UpdateSubscription(UpdateSubscriptionRequest request, ServerCallContext context)

Updates an existing subscription by updating the fields specified in the update mask. Note that certain properties of a subscription, such as its topic, are not modifiable.

Parameters
Name	Description
`request`	`UpdateSubscriptionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSubscription`	The response to send back to the client (wrapped by a task).