Struct google_cloud_pubsub::client::Client

pub struct Client { /* private fields */ }

Client is a Google Pub/Sub client scoped to a single project.

Clients should be reused rather than being created as needed. A Client may be shared by multiple tasks.

Implementations

impl Client

pub async fn default() -> Result<Self, Error>

default creates a default Pub/Sub client.

pub async fn new(config: ClientConfig) -> Result<Self, Error>

new creates a Pub/Sub client.

pub async fn create_subscription(
    &self,
    id: &str,
    topic_id: &str,
    cfg: SubscriptionConfig,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<Subscription, Status>

create_subscription creates a new subscription on a topic.

id is the name of the subscription to create. It must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and must not start with “goog”.

cfg.ack_deadline is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. It must be between 10 and 600 seconds (inclusive), and is rounded down to the nearest second. If the provided ackDeadline is 0, then the default value of 10 seconds is used. Note: messages which are obtained via Subscription.Receive need not be acknowledged within this deadline, as the deadline will be automatically extended.

cfg.push_config may be set to configure this subscription for push delivery.

If the subscription already exists an error will be returned.

pub async fn get_subscriptions(
    &self,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<Vec<Subscription>, Status>

subscriptions returns an iterator which returns all of the subscriptions for the client’s project.

pub fn subscription(&self, id: &str) -> Subscription

subscription creates a reference to a subscription.

pub async fn detach_subscription(
    &self,
    fqsn: &str,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<(), Status>

detach_subscription detaches a subscription from its topic. All messages retained in the subscription are dropped. Subsequent Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.

pub async fn create_topic(
    &self,
    id: &str,
    cfg: Option<TopicConfig>,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<Topic, Status>

create_topic creates a new topic.

The specified topic ID must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and must not start with “goog”. For more information, see: https://cloud.google.com/pubsub/docs/admin#resource_names

If the topic already exists an error will be returned.

pub async fn get_topics(
    &self,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<Vec<String>, Status>

topics returns an iterator which returns all of the topics for the client’s project.

pub fn topic(&self, id: &str) -> Topic

topic creates a reference to a topic in the client’s project.

If a Topic’s Publish method is called, it has background tasks associated with it. Clean them up by calling topic.stop.

Avoid creating many Topic instances if you use them to publish.

pub fn fully_qualified_topic_name(&self, id: &str) -> String

pub fn fully_qualified_subscription_name(&self, id: &str) -> String

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.