Skip to content

Commit

Permalink
chore: generate README from templates
Browse files Browse the repository at this point in the history
  • Loading branch information
@chingor13
chingor13 committed Feb 25, 2020
1 parent e3f4087 commit 02cabc8
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 74 deletions.
7 changes: 5 additions & 2 deletions .repo-metadata.json
View file
@@ -1,13 +1,16 @@
{
"name": "bigquerystorage",
"name_pretty": "Google BigQuery Storage",
"name_pretty": "BigQuery Storage",
"product_documentation": "https://cloud.google.com/bigquery/docs/reference/storage/",
"client_documentation": "https://googleapis.dev/java/google-cloud-bigquerystorage/latest",
"api_description": "is an API for reading data stored in BigQuery. This API provides direct, high-throughput read\naccess to existing BigQuery tables, supports parallel access with automatic liquid sharding, and allows fine-grained\ncontrol over what data is returned.",
"issue_tracker": "https://issuetracker.google.com/savedsearches/559654",
"release_level": "beta",
"language": "java",
"repo": "googleapis/java-bigquerystorage",
"repo_short": "java-bigquerystorage",
"distribution_name": "com.google.cloud:google-cloud-bigquerystorage",
"api_id": "bigquerystorage.googleapis.com"
"api_id": "bigquerystorage.googleapis.com",
"transport": "grpc",
"requires_billing": true
}
181 changes: 114 additions & 67 deletions README.md
View file
@@ -1,46 +1,51 @@
Google Cloud BigQuery Storage Java Client
==================================
# Google BigQuery Storage Client for Java

Java idiomatic client for Cloud BigQuery Storage.
Java idiomatic client for [BigQuery Storage][product-docs].

[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.html)
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-bigquerystorage.svg)]( https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-bigquerystorage.svg)
[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]

- [Client Library Documentation][bigquerystorage-client-lib-docs]
- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.
Quickstart
----------
If you are using Maven with a BOM, add this to your pom.xml file.
## Quickstart

If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>3.5.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-bigquerystorage</artifactId>
<artifactId>libraries-bom</artifactId>
<version>4.1.1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-bigquerystorage</artifactId>
</dependency>
</dependencies>
```

[//]: # ({x-version-update-start:google-cloud-bigquerystorage:released})
If you are using Maven without a BOM, add this to your dependencies.

If you are using Maven without BOM, add this to your dependencies:

```xml
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-bigquerystorage</artifactId>
<version>0.125.0-beta</version>
</dependency>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-bigquerystorage</artifactId>
<version>0.125.0-beta</version>
</dependency>
```

If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-bigquerystorage:0.125.0-beta'
Expand All @@ -51,68 +56,110 @@ libraryDependencies += "com.google.cloud" % "google-cloud-bigquerystorage" % "0.
```
[//]: # ({x-version-update-end})

Authentication
--------------
## Authentication

See the [Authentication][authentication] section in the base directory's README.

## Getting Started

### Prerequisites

You will need a [Google Cloud Platform Console][developer-console] project with the BigQuery Storage [API enabled][enable-api].
You will need to [enable billing][enable-billing] to use Google BigQuery Storage.
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.

See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
### Installation and setup

About Cloud BigQuery Storage
---------------------
You'll need to obtain the `google-cloud-bigquerystorage` library. See the [Quickstart](#quickstart) section
to add `google-cloud-bigquerystorage` as a dependency in your code.

## About BigQuery Storage

Cloud BigQuery Storage is an API for reading data stored in BigQuery. This API provides direct, high-throughput read

[BigQuery Storage][product-docs] is an API for reading data stored in BigQuery. This API provides direct, high-throughput read
access to existing BigQuery tables, supports parallel access with automatic liquid sharding, and allows fine-grained
control over what data is returned.

See the [BigQuery Storage client library docs][javadocs] to learn how to
use this BigQuery Storage Client Library.

See the [Cloud BigQuery Storage client library docs][bigquerystorage-client-lib-docs] to learn how to read date stored
in BigQuery using this library.

Getting Started

#### Installation and setup
You'll need to obtain the `google-cloud-bigquerystorage` library. See the [Quickstart](#quickstart) section
to add `google-cloud-bigquerystorage` as a dependency in your code.

Transport
---------
Cloud BigQuery Storage uses gRPC for the transport layer.

Java Versions
-------------

Java 7 or above is required for using this client.
## Troubleshooting

Testing
-------
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].

This library has tools to help make tests for code using Cloud BigQuery Storage.
## Transport

Versioning
----------
BigQuery Storage uses gRPC for the transport layer.

This library follows [Semantic Versioning](http://semver.org/).
## Java Versions

It is currently in major version zero (``0.y.z``), which means that anything
may change at any time and the public API should not be considered
stable.
Java 7 or above is required for using this client.

Contributing
------------
## Versioning

Contributions to this library are always welcome and highly encouraged.
This library follows [Semantic Versioning](http://semver.org/).

See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more information.
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
and the public API should not be considered stable.

License
-------

Apache 2.0 - See [LICENSE] for more information.
## Contributing


[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
Contributions to this library are always welcome and highly encouraged.

[bigquerystorage-client-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/bigquery/storage/v1beta1/package-summary.html
See [CONTRIBUTING][contributing] for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
information.

## License

Apache 2.0 - See [LICENSE][license] for more information.

## CI Status

Java Version | Status
------------ | ------
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]

[product-docs]: https://cloud.google.com/bigquery/docs/reference/storage/
[javadocs]: https://googleapis.dev/java/google-cloud-bigquerystorage/latest
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquerystorage/java11.html
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-bigquerystorage.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-bigquerystorage&core=gav
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-bigquerystorage/blob/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-bigquerystorage/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-bigquerystorage/blob/master/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=bigquerystorage.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
6 changes: 1 addition & 5 deletions synth.py
View file
Expand Up @@ -32,8 +32,4 @@
destination_name='bigquerystorage',
)

common_templates = gcp.CommonTemplates()
templates = common_templates.java_library()
s.copy(templates, excludes=[
'README.md',
])
java.common_templates()

0 comments on commit 02cabc8

Please sign in to comment.