Struct google_api_proto::google::pubsub::v1beta2::subscriber_client::SubscriberClient

pub struct SubscriberClient<T> { /* private fields */ }

The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the Pull method.

Implementations

impl<T> SubscriberClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> SubscriberClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn create_subscription( &mut self, request: impl IntoRequest<Subscription>, ) -> Result<Response<Subscription>, Status>

Creates a subscription to a given topic for a given subscriber. 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.

pub async fn get_subscription( &mut self, request: impl IntoRequest<GetSubscriptionRequest>, ) -> Result<Response<Subscription>, Status>

Gets the configuration details of a subscription.

pub async fn list_subscriptions( &mut self, request: impl IntoRequest<ListSubscriptionsRequest>, ) -> Result<Response<ListSubscriptionsResponse>, Status>

Lists matching subscriptions.

pub async fn delete_subscription( &mut self, request: impl IntoRequest<DeleteSubscriptionRequest>, ) -> Result<Response<()>, Status>

Deletes an existing subscription. All pending messages 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.

pub async fn modify_ack_deadline( &mut self, request: impl IntoRequest<ModifyAckDeadlineRequest>, ) -> Result<Response<()>, Status>

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.

pub async fn acknowledge( &mut self, request: impl IntoRequest<AcknowledgeRequest>, ) -> Result<Response<()>, Status>

Acknowledges the messages associated with the ack tokens 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.

pub async fn pull( &mut self, request: impl IntoRequest<PullRequest>, ) -> Result<Response<PullResponse>, Status>

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.

pub async fn modify_push_config( &mut self, request: impl IntoRequest<ModifyPushConfigRequest>, ) -> Result<Response<()>, Status>

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.

Trait Implementations

impl<T: Clone> Clone for SubscriberClient<T>

fn clone(&self) -> SubscriberClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for SubscriberClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.