From f96810459fc8e9393518f784a62e5c32b5230107 Mon Sep 17 00:00:00 2001 From: Tianzi Cai Date: Tue, 26 Jan 2021 17:05:25 -0800 Subject: [PATCH] docs: update README about and correct distribution name in repo metadata (#16) --- .readme-partials.yaml | 11 +++++++++++ .repo-metadata.json | 4 ++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.readme-partials.yaml b/.readme-partials.yaml index 2c506be2..08283d6b 100644 --- a/.readme-partials.yaml +++ b/.readme-partials.yaml @@ -97,3 +97,14 @@ custom_content: | ```java spark.readStream.format("pubsublite").option("gcp.credentials.key", "") ``` +about: | + [Google Cloud Pub/Sub Lite][product-docs] 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. + + The Pub/Sub Lite Spark connector supports Pub/Sub Lite as an input source to + Apache Spark Structured Streaming in both the default micro-batch processing + mode and the _experimental_ continous processing mode. The connector works in + all Apache Spark distributions, including [Google Cloud Dataproc](https://cloud.google.com/dataproc/docs/) + and manual Spark installations. diff --git a/.repo-metadata.json b/.repo-metadata.json index ac31b109..93ec87a2 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -2,7 +2,7 @@ "name": "pubsublite-spark", "name_pretty": "Pub/Sub Lite Spark Connector", "product_documentation": "https://cloud.google.com/pubsub/lite/docs", - "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.", + "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.", "client_documentation": "https://googleapis.dev/java/google-cloud-pubsublite/latest/index.html", "release_level": "alpha", "transport": "grpc", @@ -11,7 +11,7 @@ "min_java_version": 8, "repo": "googleapis/java-pubsublite-spark", "repo_short": "java-pubsublite-spark", - "distribution_name": "com.google.cloud:pubsublite-spark", + "distribution_name": "com.google.cloud:pubsublite-spark-sql-streaming", "codeowner_team": "@googleapis/api-pubsub", "api_id": "pubsublite.googleapis.com" } \ No newline at end of file