1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
//! # google-cloud-pubsub
//!
//! Google Cloud Platform pub/sub library.
//!
//! * [About Cloud Pub/Sub](https://cloud.google.com/pubsub/)
//! * [Pub/Sub API Documentation](https://cloud.google.com/pubsub/docs)
//!
//! ## Quickstart
//!
//! ### Authentication
//! There are two ways to create a client that is authenticated against the google cloud.
//!
//! The crate [google-cloud-default](https://crates.io/crates/google-cloud-default) provides two methods that help to implement those.
//!
//! #### Automatically
//!
//! The function `with_auth()` will try and read the credentials from a file specified in the environment variable `GOOGLE_APPLICATION_CREDENTIALS`, `GOOGLE_APPLICATION_CREDENTIALS_JSON` or
//! from a metadata server.
//!
//! This is also described in [google-cloud-auth](https://github.com/yoshidan/google-cloud-rust/blob/main/foundation/auth/README.md)
//!
//! ```ignore
//! use google_cloud_pubsub::client::{ClientConfig, Client};
//! use google_cloud_default::WithAuthExt;
//!
//! async fn run() {
//! let config = ClientConfig::default().with_auth().await.unwrap();
//! let client = Client::new(config).await.unwrap();
//! }
//! ```
//!
//! ### Manually
//!
//! When you cant use the `gcloud` authentication but you have a different way to get your credentials (e.g a different environment variable)
//! you can parse your own version of the 'credentials-file' and use it like that:
//!
//! ```ignore
//! use google_cloud_auth::credentials::CredentialsFile;
//! use google_cloud_pubsub::client::{ClientConfig, Client};
//! use google_cloud_default::WithAuthExt;
//!
//! async fn run(cred: CredentialsFile) {
//! let config = ClientConfig::default().with_credentials(cred).await.unwrap();
//! let client = Client::new(config).await.unwrap();
//! }
//! ```
//!
//! ### Emulator
//! For tests, you can use the [Emulator-Option](https://github.com/yoshidan/google-cloud-rust/blob/cbd5ed1315d7b828c89a50fe71fcbaf15ddc964b/pubsub/src/client.rs#L32) like that:
//! Before executing the program, specify the address of the emulator in the following environment variable.
//!
//! ```sh
//! export PUBSUB_EMULATOR_HOST=localhost:8681
//! ```
//!
//! ### Publish Message
//!
//! ```
//! use google_cloud_pubsub::client::{Client, ClientConfig};
//! use google_cloud_googleapis::pubsub::v1::PubsubMessage;
//! use google_cloud_pubsub::topic::TopicConfig;
//! use google_cloud_pubsub::subscription::SubscriptionConfig;
//! use google_cloud_gax::grpc::Status;
//! use tokio::task::JoinHandle;
//! use tokio_util::sync::CancellationToken;
//!
//! async fn run(config: ClientConfig) -> Result<(), Status> {
//!
//! // Create pubsub client.
//! let client = Client::new(config).await.unwrap();
//!
//! // Create topic.
//! let topic = client.topic("test-topic");
//! if !topic.exists(None).await? {
//! topic.create(None, None).await?;
//! }
//!
//! // Start publisher.
//! let publisher = topic.new_publisher(None);
//!
//! // Publish message.
//! let tasks : Vec<JoinHandle<Result<String,Status>>> = (0..10).into_iter().map(|_i| {
//! let publisher = publisher.clone();
//! tokio::spawn(async move {
//! let msg = PubsubMessage {
//! data: "abc".into(),
//! // Set ordering_key if needed (https://cloud.google.com/pubsub/docs/ordering)
//! ordering_key: "order".into(),
//! ..Default::default()
//! };
//!
//! // Send a message. There are also `publish_bulk` and `publish_immediately` methods.
//! let mut awaiter = publisher.publish(msg).await;
//!
//! // The get method blocks until a server-generated ID or an error is returned for the published message.
//! awaiter.get().await
//! })
//! }).collect();
//!
//! // Wait for all publish task finish
//! for task in tasks {
//! let message_id = task.await.unwrap()?;
//! }
//!
//! // Wait for publishers in topic finish.
//! let mut publisher = publisher;
//! publisher.shutdown();
//!
//! Ok(())
//! }
//! ```
//!
//! ### Subscribe Message
//!
//! ```
//! use google_cloud_pubsub::client::{Client, ClientConfig};
//! use google_cloud_googleapis::pubsub::v1::PubsubMessage;
//! use google_cloud_pubsub::subscription::SubscriptionConfig;
//! use google_cloud_gax::grpc::Status;
//! use std::time::Duration;
//! use tokio_util::sync::CancellationToken;
//! use futures_util::StreamExt;
//!
//! async fn run(config: ClientConfig) -> Result<(), Status> {
//!
//! // Create pubsub client.
//! let client = Client::new(config).await.unwrap();
//!
//! // Get the topic to subscribe to.
//! let topic = client.topic("test-topic");
//!
//! // Create subscription
//! // If subscription name does not contain a "/", then the project is taken from client above. Otherwise, the
//! // name will be treated as a fully qualified resource name
//! let config = SubscriptionConfig {
//! // Enable message ordering if needed (https://cloud.google.com/pubsub/docs/ordering)
//! enable_message_ordering: true,
//! ..Default::default()
//! };
//!
//! // Create subscription
//! let subscription = client.subscription("test-subscription");
//! if !subscription.exists(None).await? {
//! subscription.create(topic.fully_qualified_name(), config, None).await?;
//! }
//!
//! // Token for cancel.
//! let cancel = CancellationToken::new();
//! let cancel2 = cancel.clone();
//! tokio::spawn(async move {
//! // Cancel after 10 seconds.
//! tokio::time::sleep(Duration::from_secs(10)).await;
//! cancel2.cancel();
//! });
//!
//! // Receive blocks until the ctx is cancelled or an error occurs.
//! // Or simply use the `subscription.subscribe` method.
//! subscription.receive(|mut message, cancel| async move {
//! // Handle data.
//! println!("Got Message: {:?}", message.message.data);
//!
//! // Ack or Nack message.
//! let _ = message.ack().await;
//! }, cancel.clone(), None).await?;
//!
//! // Delete subscription if needed.
//! subscription.delete(None).await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ### Subscribe Message (Alternative Way)
//!
//! ```no_run
//! use google_cloud_pubsub::client::{Client, ClientConfig};
//! use google_cloud_googleapis::pubsub::v1::PubsubMessage;
//! use google_cloud_pubsub::subscription::SubscriptionConfig;
//! use google_cloud_gax::grpc::Status;
//! use std::time::Duration;
//! use tokio_util::sync::CancellationToken;
//! use futures_util::StreamExt;
//!
//! async fn run(config: ClientConfig) -> Result<(), Status> {
//! // Creating Client, Topic and Subscription...
//! let client = Client::new(config).await.unwrap();
//! let subscription = client.subscription("test-subscription");
//!
//! // Read the messages as a stream
//! // (needs futures_util::StreamExt as import)
//! // Note: This blocks the current thread but helps working with non clonable data
//! let mut stream = subscription.subscribe(None).await?;
//! while let Some(message) = stream.next().await {
//! // Handle data.
//! println!("Got Message: {:?}", message.message);
//!
//! // Ack or Nack message.
//! let _ = message.ack().await;
//! }
//! Ok(())
//! }
//! ```
pub mod apiv1;
pub mod client;
pub mod publisher;
pub mod subscriber;
pub mod subscription;
pub mod topic;
pub mod util;