Skip to content

Commit f968104

Browse files
docs: update README about and correct distribution name in repo metadata (#16)
1 parent 6aa40af commit f968104

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

.readme-partials.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,14 @@ custom_content: |
9797
```java
9898
spark.readStream.format("pubsublite").option("gcp.credentials.key", "<SERVICE_ACCOUNT_JSON_IN_BASE64>")
9999
```
100+
about: |
101+
[Google Cloud Pub/Sub Lite][product-docs] is a zonal, real-time messaging
102+
service that lets you send and receive messages between independent
103+
applications. You can manually configure the throughput and storage capacity
104+
for Pub/Sub Lite systems.
105+
106+
The Pub/Sub Lite Spark connector supports Pub/Sub Lite as an input source to
107+
Apache Spark Structured Streaming in both the default micro-batch processing
108+
mode and the _experimental_ continous processing mode. The connector works in
109+
all Apache Spark distributions, including [Google Cloud Dataproc](https://cloud.google.com/dataproc/docs/)
110+
and manual Spark installations.

.repo-metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "pubsublite-spark",
33
"name_pretty": "Pub/Sub Lite Spark Connector",
44
"product_documentation": "https://cloud.google.com/pubsub/lite/docs",
5-
"api_description": "is designed to provide reliable,\nmany-to-many, asynchronous messaging between applications. Publisher\napplications can send messages to a topic and other applications can\nsubscribe to that topic to receive the messages. By decoupling senders and\nreceivers, Google Cloud Pub/Sub allows developers to communicate between\nindependently written applications.\n\nCompared to Google Pub/Sub, Pub/Sub Lite provides partitioned zonal data\nstorage with predefined capacity. Both products present a similar API, but\nPub/Sub Lite has more usage caveats.\n\nSee the [Google Pub/Sub Lite docs](https://cloud.google.com/pubsub/quickstart-console#before-you-begin) for more details on how to activate\nPub/Sub Lite for your project, as well as guidance on how to choose between\nCloud Pub/Sub and Pub/Sub Lite.",
5+
"api_description": "Pub/Sub Lite is a zonal, real-time messaging service that lets you send and receive messages between independent applications. You can manually configure the throughput and storage capacity for Pub/Sub Lite systems.",
66
"client_documentation": "https://googleapis.dev/java/google-cloud-pubsublite/latest/index.html",
77
"release_level": "alpha",
88
"transport": "grpc",
@@ -11,7 +11,7 @@
1111
"min_java_version": 8,
1212
"repo": "googleapis/java-pubsublite-spark",
1313
"repo_short": "java-pubsublite-spark",
14-
"distribution_name": "com.google.cloud:pubsublite-spark",
14+
"distribution_name": "com.google.cloud:pubsublite-spark-sql-streaming",
1515
"codeowner_team": "@googleapis/api-pubsub",
1616
"api_id": "pubsublite.googleapis.com"
1717
}

0 commit comments

Comments
 (0)