Class protos.google.pubsub.v1.Subscriber (3.2.1)

Represents a Subscriber

Inheritance

$protobuf.rpc.Service > protos.google.pubsub.v1.Subscriber

Package

@google-cloud/pubsub

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Subscriber service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

acknowledge(request, callback)

public acknowledge(request: google.pubsub.v1.IAcknowledgeRequest, callback: google.pubsub.v1.Subscriber.AcknowledgeCallback): void;

Calls Acknowledge.

Parameters
Name Description
request IAcknowledgeRequest

AcknowledgeRequest message or plain object
callback google.pubsub.v1.Subscriber.AcknowledgeCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

acknowledge(request)

public acknowledge(request: google.pubsub.v1.IAcknowledgeRequest): Promise<google.protobuf.Empty>;

Calls Acknowledge.

Parameter
Name Description
request IAcknowledgeRequest

AcknowledgeRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Subscriber;

Creates new Subscriber service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
Subscriber

RPC service. Useful where requests and/or responses are streamed.

createSnapshot(request, callback)

public createSnapshot(request: google.pubsub.v1.ICreateSnapshotRequest, callback: google.pubsub.v1.Subscriber.CreateSnapshotCallback): void;

Calls CreateSnapshot.

Parameters
Name Description
request ICreateSnapshotRequest

CreateSnapshotRequest message or plain object
callback google.pubsub.v1.Subscriber.CreateSnapshotCallback

Node-style callback called with the error, if any, and Snapshot
Returns
Type Description
void

createSnapshot(request)

public createSnapshot(request: google.pubsub.v1.ICreateSnapshotRequest): Promise<google.pubsub.v1.Snapshot>;

Calls CreateSnapshot.

Parameter
Name Description
request ICreateSnapshotRequest

CreateSnapshotRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.Snapshot>

Promise

createSubscription(request, callback)

public createSubscription(request: google.pubsub.v1.ISubscription, callback: google.pubsub.v1.Subscriber.CreateSubscriptionCallback): void;

Calls CreateSubscription.

Parameters
Name Description
request ISubscription

Subscription message or plain object
callback google.pubsub.v1.Subscriber.CreateSubscriptionCallback

Node-style callback called with the error, if any, and Subscription
Returns
Type Description
void

createSubscription(request)

public createSubscription(request: google.pubsub.v1.ISubscription): Promise<google.pubsub.v1.Subscription>;

Calls CreateSubscription.

Parameter
Name Description
request ISubscription

Subscription message or plain object
Returns
Type Description
Promise<google.pubsub.v1.Subscription>

Promise

deleteSnapshot(request, callback)

public deleteSnapshot(request: google.pubsub.v1.IDeleteSnapshotRequest, callback: google.pubsub.v1.Subscriber.DeleteSnapshotCallback): void;

Calls DeleteSnapshot.

Parameters
Name Description
request IDeleteSnapshotRequest

DeleteSnapshotRequest message or plain object
callback google.pubsub.v1.Subscriber.DeleteSnapshotCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteSnapshot(request)

public deleteSnapshot(request: google.pubsub.v1.IDeleteSnapshotRequest): Promise<google.protobuf.Empty>;

Calls DeleteSnapshot.

Parameter
Name Description
request IDeleteSnapshotRequest

DeleteSnapshotRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteSubscription(request, callback)

public deleteSubscription(request: google.pubsub.v1.IDeleteSubscriptionRequest, callback: google.pubsub.v1.Subscriber.DeleteSubscriptionCallback): void;

Calls DeleteSubscription.

Parameters
Name Description
request IDeleteSubscriptionRequest

DeleteSubscriptionRequest message or plain object
callback google.pubsub.v1.Subscriber.DeleteSubscriptionCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteSubscription(request)

public deleteSubscription(request: google.pubsub.v1.IDeleteSubscriptionRequest): Promise<google.protobuf.Empty>;

Calls DeleteSubscription.

Parameter
Name Description
request IDeleteSubscriptionRequest

DeleteSubscriptionRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

getSnapshot(request, callback)

public getSnapshot(request: google.pubsub.v1.IGetSnapshotRequest, callback: google.pubsub.v1.Subscriber.GetSnapshotCallback): void;

Calls GetSnapshot.

Parameters
Name Description
request IGetSnapshotRequest

GetSnapshotRequest message or plain object
callback google.pubsub.v1.Subscriber.GetSnapshotCallback

Node-style callback called with the error, if any, and Snapshot
Returns
Type Description
void

getSnapshot(request)

public getSnapshot(request: google.pubsub.v1.IGetSnapshotRequest): Promise<google.pubsub.v1.Snapshot>;

Calls GetSnapshot.

Parameter
Name Description
request IGetSnapshotRequest

GetSnapshotRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.Snapshot>

Promise

getSubscription(request, callback)

public getSubscription(request: google.pubsub.v1.IGetSubscriptionRequest, callback: google.pubsub.v1.Subscriber.GetSubscriptionCallback): void;

Calls GetSubscription.

Parameters
Name Description
request IGetSubscriptionRequest

GetSubscriptionRequest message or plain object
callback google.pubsub.v1.Subscriber.GetSubscriptionCallback

Node-style callback called with the error, if any, and Subscription
Returns
Type Description
void

getSubscription(request)

public getSubscription(request: google.pubsub.v1.IGetSubscriptionRequest): Promise<google.pubsub.v1.Subscription>;

Calls GetSubscription.

Parameter
Name Description
request IGetSubscriptionRequest

GetSubscriptionRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.Subscription>

Promise

listSnapshots(request, callback)

public listSnapshots(request: google.pubsub.v1.IListSnapshotsRequest, callback: google.pubsub.v1.Subscriber.ListSnapshotsCallback): void;

Calls ListSnapshots.

Parameters
Name Description
request IListSnapshotsRequest

ListSnapshotsRequest message or plain object
callback google.pubsub.v1.Subscriber.ListSnapshotsCallback

Node-style callback called with the error, if any, and ListSnapshotsResponse
Returns
Type Description
void

listSnapshots(request)

public listSnapshots(request: google.pubsub.v1.IListSnapshotsRequest): Promise<google.pubsub.v1.ListSnapshotsResponse>;

Calls ListSnapshots.

Parameter
Name Description
request IListSnapshotsRequest

ListSnapshotsRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.ListSnapshotsResponse>

Promise

listSubscriptions(request, callback)

public listSubscriptions(request: google.pubsub.v1.IListSubscriptionsRequest, callback: google.pubsub.v1.Subscriber.ListSubscriptionsCallback): void;

Calls ListSubscriptions.

Parameters
Name Description
request IListSubscriptionsRequest

ListSubscriptionsRequest message or plain object
callback google.pubsub.v1.Subscriber.ListSubscriptionsCallback

Node-style callback called with the error, if any, and ListSubscriptionsResponse
Returns
Type Description
void

listSubscriptions(request)

public listSubscriptions(request: google.pubsub.v1.IListSubscriptionsRequest): Promise<google.pubsub.v1.ListSubscriptionsResponse>;

Calls ListSubscriptions.

Parameter
Name Description
request IListSubscriptionsRequest

ListSubscriptionsRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.ListSubscriptionsResponse>

Promise

modifyAckDeadline(request, callback)

public modifyAckDeadline(request: google.pubsub.v1.IModifyAckDeadlineRequest, callback: google.pubsub.v1.Subscriber.ModifyAckDeadlineCallback): void;

Calls ModifyAckDeadline.

Parameters
Name Description
request IModifyAckDeadlineRequest

ModifyAckDeadlineRequest message or plain object
callback google.pubsub.v1.Subscriber.ModifyAckDeadlineCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

modifyAckDeadline(request)

public modifyAckDeadline(request: google.pubsub.v1.IModifyAckDeadlineRequest): Promise<google.protobuf.Empty>;

Calls ModifyAckDeadline.

Parameter
Name Description
request IModifyAckDeadlineRequest

ModifyAckDeadlineRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

modifyPushConfig(request, callback)

public modifyPushConfig(request: google.pubsub.v1.IModifyPushConfigRequest, callback: google.pubsub.v1.Subscriber.ModifyPushConfigCallback): void;

Calls ModifyPushConfig.

Parameters
Name Description
request IModifyPushConfigRequest

ModifyPushConfigRequest message or plain object
callback google.pubsub.v1.Subscriber.ModifyPushConfigCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

modifyPushConfig(request)

public modifyPushConfig(request: google.pubsub.v1.IModifyPushConfigRequest): Promise<google.protobuf.Empty>;

Calls ModifyPushConfig.

Parameter
Name Description
request IModifyPushConfigRequest

ModifyPushConfigRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

pull(request, callback)

public pull(request: google.pubsub.v1.IPullRequest, callback: google.pubsub.v1.Subscriber.PullCallback): void;

Calls Pull.

Parameters
Name Description
request IPullRequest

PullRequest message or plain object
callback google.pubsub.v1.Subscriber.PullCallback

Node-style callback called with the error, if any, and PullResponse
Returns
Type Description
void

pull(request)

public pull(request: google.pubsub.v1.IPullRequest): Promise<google.pubsub.v1.PullResponse>;

Calls Pull.

Parameter
Name Description
request IPullRequest

PullRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.PullResponse>

Promise

seek(request, callback)

public seek(request: google.pubsub.v1.ISeekRequest, callback: google.pubsub.v1.Subscriber.SeekCallback): void;

Calls Seek.

Parameters
Name Description
request ISeekRequest

SeekRequest message or plain object
callback google.pubsub.v1.Subscriber.SeekCallback

Node-style callback called with the error, if any, and SeekResponse
Returns
Type Description
void

seek(request)

public seek(request: google.pubsub.v1.ISeekRequest): Promise<google.pubsub.v1.SeekResponse>;

Calls Seek.

Parameter
Name Description
request ISeekRequest

SeekRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.SeekResponse>

Promise

streamingPull(request, callback)

public streamingPull(request: google.pubsub.v1.IStreamingPullRequest, callback: google.pubsub.v1.Subscriber.StreamingPullCallback): void;

Calls StreamingPull.

Parameters
Name Description
request IStreamingPullRequest

StreamingPullRequest message or plain object
callback google.pubsub.v1.Subscriber.StreamingPullCallback

Node-style callback called with the error, if any, and StreamingPullResponse
Returns
Type Description
void

streamingPull(request)

public streamingPull(request: google.pubsub.v1.IStreamingPullRequest): Promise<google.pubsub.v1.StreamingPullResponse>;

Calls StreamingPull.

Parameter
Name Description
request IStreamingPullRequest

StreamingPullRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.StreamingPullResponse>

Promise

updateSnapshot(request, callback)

public updateSnapshot(request: google.pubsub.v1.IUpdateSnapshotRequest, callback: google.pubsub.v1.Subscriber.UpdateSnapshotCallback): void;

Calls UpdateSnapshot.

Parameters
Name Description
request IUpdateSnapshotRequest

UpdateSnapshotRequest message or plain object
callback google.pubsub.v1.Subscriber.UpdateSnapshotCallback

Node-style callback called with the error, if any, and Snapshot
Returns
Type Description
void

updateSnapshot(request)

public updateSnapshot(request: google.pubsub.v1.IUpdateSnapshotRequest): Promise<google.pubsub.v1.Snapshot>;

Calls UpdateSnapshot.

Parameter
Name Description
request IUpdateSnapshotRequest

UpdateSnapshotRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.Snapshot>

Promise

updateSubscription(request, callback)

public updateSubscription(request: google.pubsub.v1.IUpdateSubscriptionRequest, callback: google.pubsub.v1.Subscriber.UpdateSubscriptionCallback): void;

Calls UpdateSubscription.

Parameters
Name Description
request IUpdateSubscriptionRequest

UpdateSubscriptionRequest message or plain object
callback google.pubsub.v1.Subscriber.UpdateSubscriptionCallback

Node-style callback called with the error, if any, and Subscription
Returns
Type Description
void

updateSubscription(request)

public updateSubscription(request: google.pubsub.v1.IUpdateSubscriptionRequest): Promise<google.pubsub.v1.Subscription>;

Calls UpdateSubscription.

Parameter
Name Description
request IUpdateSubscriptionRequest

UpdateSubscriptionRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.Subscription>

Promise