Skip to content

Commit

Permalink
docs: update README about and correct distribution name in repo metad…
Browse files Browse the repository at this point in the history
…ata (#16)
  • Loading branch information
anguillanneuf committed Jan 27, 2021
1 parent 6aa40af commit f968104
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
11 changes: 11 additions & 0 deletions .readme-partials.yaml
Expand Up @@ -97,3 +97,14 @@ custom_content: |
```java
spark.readStream.format("pubsublite").option("gcp.credentials.key", "<SERVICE_ACCOUNT_JSON_IN_BASE64>")
```
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.
4 changes: 2 additions & 2 deletions .repo-metadata.json
Expand Up @@ -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",
Expand All @@ -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"
}

0 comments on commit f968104

Please sign in to comment.