abstract class SubscriberClient extends SubscriberClientPowerApi with Subscriber with AkkaGrpcClient
- Annotations
- @AkkaGrpcGenerated()
- Source
- SubscriberClient.java
- Alphabetic
- By Inheritance
- SubscriberClient
- AkkaGrpcClient
- Subscriber
- SubscriberClientPowerApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SubscriberClient()
Abstract Value Members
- abstract def acknowledge(in: AcknowledgeRequest): CompletionStage[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.- Definition Classes
- Subscriber
- abstract def close(): CompletionStage[Done]
- Definition Classes
- AkkaGrpcClient
- abstract def closed(): CompletionStage[Done]
- Definition Classes
- AkkaGrpcClient
- abstract def createSnapshot(in: CreateSnapshotRequest): CompletionStage[Snapshot]
Creates a snapshot from the requested subscription.
Creates a snapshot from the requested subscription. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) 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, 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.- Definition Classes
- Subscriber
- abstract def createSubscription(in: Subscription): CompletionStage[Subscription]
Creates a subscription to a given topic.
Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). 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.- Definition Classes
- Subscriber
- abstract def deleteSnapshot(in: DeleteSnapshotRequest): CompletionStage[Empty]
Removes an existing snapshot.
Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) 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.
- Definition Classes
- Subscriber
- abstract def deleteSubscription(in: DeleteSubscriptionRequest): CompletionStage[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.- Definition Classes
- Subscriber
- abstract def getSnapshot(in: GetSnapshotRequest): CompletionStage[Snapshot]
Gets the configuration details of a snapshot.
Gets the configuration details of a snapshot. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) 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.
- Definition Classes
- Subscriber
- abstract def getSubscription(in: GetSubscriptionRequest): CompletionStage[Subscription]
Gets the configuration details of a subscription.
Gets the configuration details of a subscription.
- Definition Classes
- Subscriber
- abstract def listSnapshots(in: ListSnapshotsRequest): CompletionStage[ListSnapshotsResponse]
Lists the existing snapshots.
Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) 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.
- Definition Classes
- Subscriber
- abstract def listSubscriptions(in: ListSubscriptionsRequest): CompletionStage[ListSubscriptionsResponse]
Lists matching subscriptions.
Lists matching subscriptions.
- Definition Classes
- Subscriber
- abstract def modifyAckDeadline(in: ModifyAckDeadlineRequest): CompletionStage[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.- Definition Classes
- Subscriber
- abstract def modifyPushConfig(in: ModifyPushConfigRequest): CompletionStage[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
.- Definition Classes
- Subscriber
- abstract def pull(in: PullRequest): CompletionStage[PullResponse]
Pulls messages from the server.
Pulls messages from the server.
- Definition Classes
- Subscriber
- abstract def seek(in: SeekRequest): CompletionStage[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 [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) 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.
- Definition Classes
- Subscriber
- 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.- Definition Classes
- Subscriber
- abstract def updateSnapshot(in: UpdateSnapshotRequest): CompletionStage[Snapshot]
Updates an existing snapshot.
Updates an existing snapshot. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) 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.
- Definition Classes
- Subscriber
- abstract def updateSubscription(in: UpdateSubscriptionRequest): CompletionStage[Subscription]
Updates an existing subscription.
Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
- Definition Classes
- Subscriber
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
- def acknowledge(): SingleResponseRequestBuilder[AcknowledgeRequest, Empty]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer acknowledge(com.google.pubsub.v1.AcknowledgeRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def createSnapshot(): SingleResponseRequestBuilder[CreateSnapshotRequest, Snapshot]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer createSnapshot(com.google.pubsub.v1.CreateSnapshotRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def createSubscription(): SingleResponseRequestBuilder[Subscription, Subscription]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer createSubscription(com.google.pubsub.v1.Subscription) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def deleteSnapshot(): SingleResponseRequestBuilder[DeleteSnapshotRequest, Empty]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer deleteSnapshot(com.google.pubsub.v1.DeleteSnapshotRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def deleteSubscription(): SingleResponseRequestBuilder[DeleteSubscriptionRequest, Empty]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer deleteSubscription(com.google.pubsub.v1.DeleteSubscriptionRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getSnapshot(): SingleResponseRequestBuilder[GetSnapshotRequest, Snapshot]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer getSnapshot(com.google.pubsub.v1.GetSnapshotRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def getSubscription(): SingleResponseRequestBuilder[GetSubscriptionRequest, Subscription]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer getSubscription(com.google.pubsub.v1.GetSubscriptionRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def listSnapshots(): SingleResponseRequestBuilder[ListSnapshotsRequest, ListSnapshotsResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer listSnapshots(com.google.pubsub.v1.ListSnapshotsRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def listSubscriptions(): SingleResponseRequestBuilder[ListSubscriptionsRequest, ListSubscriptionsResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer listSubscriptions(com.google.pubsub.v1.ListSubscriptionsRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def modifyAckDeadline(): SingleResponseRequestBuilder[ModifyAckDeadlineRequest, Empty]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer modifyAckDeadline(com.google.pubsub.v1.ModifyAckDeadlineRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def modifyPushConfig(): SingleResponseRequestBuilder[ModifyPushConfigRequest, Empty]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer modifyPushConfig(com.google.pubsub.v1.ModifyPushConfigRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def pull(): SingleResponseRequestBuilder[PullRequest, PullResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer pull(com.google.pubsub.v1.PullRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def seek(): SingleResponseRequestBuilder[SeekRequest, SeekResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer seek(com.google.pubsub.v1.SeekRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def streamingPull(): StreamResponseRequestBuilder[Source[StreamingPullRequest, NotUsed], StreamingPullResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer streamingPull(com.google.pubsub.v1.StreamingPullRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def updateSnapshot(): SingleResponseRequestBuilder[UpdateSnapshotRequest, Snapshot]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer updateSnapshot(com.google.pubsub.v1.UpdateSnapshotRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- def updateSubscription(): SingleResponseRequestBuilder[UpdateSubscriptionRequest, Subscription]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer updateSubscription(com.google.pubsub.v1.UpdateSubscriptionRequest) if possible.
- Definition Classes
- SubscriberClientPowerApi
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()