trait Subscriber extends AnyRef
The service that an application uses to manipulate subscriptions and to
consume messages from a subscription via the Pull
method or by
establishing a bi-directional stream using the StreamingPull
method.
- Source
- Subscriber.scala
- Alphabetic
- By Inheritance
- Subscriber
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
acknowledge(in: AcknowledgeRequest): Future[Empty]
Acknowledges the messages associated with the
ack_ids
in theAcknowledgeRequest
.Acknowledges the messages associated with the
ack_ids
in theAcknowledgeRequest
. 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. -
abstract
def
createSnapshot(in: CreateSnapshotRequest): Future[Snapshot]
Creates a snapshot from the requested subscription.
Creates a snapshot from the requested subscription. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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. <br><br>If the snapshot already exists, returns
ALREADY_EXISTS
. If the requested subscription doesn't exist, returnsNOT_FOUND
. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- thenFAILED_PRECONDITION
is returned. See also theSnapshot.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](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request. -
abstract
def
createSubscription(in: Subscription): Future[Subscription]
Creates a subscription to a given topic.
Creates a subscription to a given topic. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. If the subscription already exists, returns
ALREADY_EXISTS
. If the corresponding topic doesn't exist, returnsNOT_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](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request. -
abstract
def
deleteSnapshot(in: DeleteSnapshotRequest): Future[Empty]
Removes an existing snapshot.
Removes an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.<br><br> 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.
-
abstract
def
deleteSubscription(in: DeleteSubscriptionRequest): Future[Empty]
Deletes an existing subscription.
Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to
Pull
after deletion will returnNOT_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. -
abstract
def
getSnapshot(in: GetSnapshotRequest): Future[Snapshot]
Gets the configuration details of a snapshot.
Gets the configuration details of a snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
-
abstract
def
getSubscription(in: GetSubscriptionRequest): Future[Subscription]
Gets the configuration details of a subscription.
-
abstract
def
listSnapshots(in: ListSnapshotsRequest): Future[ListSnapshotsResponse]
Lists the existing snapshots.
Lists the existing snapshots. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
-
abstract
def
listSubscriptions(in: ListSubscriptionsRequest): Future[ListSubscriptionsResponse]
Lists matching subscriptions.
-
abstract
def
modifyAckDeadline(in: ModifyAckDeadlineRequest): Future[Empty]
Modifies the ack deadline for a specific message.
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. -
abstract
def
modifyPushConfig(in: ModifyPushConfigRequest): Future[Empty]
Modifies the
PushConfig
for a specified subscription.Modifies the
PushConfig
for a specified subscription. This may be used to change a push subscription to a pull one (signified by an emptyPushConfig
) 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 thePushConfig
. -
abstract
def
pull(in: PullRequest): Future[PullResponse]
Pulls messages from the server.
Pulls messages from the server. The server may return
UNAVAILABLE
if there are too many concurrent pull requests pending for the given subscription. -
abstract
def
seek(in: SeekRequest): Future[SeekResponse]
Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.
Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
-
abstract
def
streamingPull(in: Source[StreamingPullRequest, NotUsed]): Source[StreamingPullResponse, NotUsed]
Establishes a stream with the server, which sends messages down to the client.
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. -
abstract
def
updateSnapshot(in: UpdateSnapshotRequest): Future[Snapshot]
Updates an existing snapshot.
Updates an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
-
abstract
def
updateSubscription(in: UpdateSubscriptionRequest): Future[Subscription]
Updates an existing subscription.
Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )