This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update dependencies and README
- Loading branch information
Showing
4 changed files
with
140 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
# Cloud Composer Client for Java | ||
|
||
Java idiomatic client for [Cloud Composer][product-docs]. | ||
|
||
[![Maven][maven-version-image]][maven-version-link] | ||
![Stability][stability-image] | ||
|
||
- [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, add this to your pom.xml file: | ||
|
||
```xml | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-orchestration-airflow</artifactId> | ||
<version>0.0.0</version> | ||
</dependency> | ||
``` | ||
|
||
If you are using Gradle without BOM, add this to your dependencies | ||
```Groovy | ||
compile 'com.google.cloud:google-cloud-orchestration-airflow:0.0.0' | ||
``` | ||
|
||
If you are using SBT, add this to your dependencies | ||
```Scala | ||
libraryDependencies += "com.google.cloud" % "google-cloud-orchestration-airflow" % "0.0.0" | ||
``` | ||
|
||
## 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 Cloud Composer [API enabled][enable-api]. | ||
You will need to [enable billing][enable-billing] to use Cloud Composer. | ||
[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]`. | ||
|
||
### Installation and setup | ||
|
||
You'll need to obtain the `google-cloud-orchestration-airflow` library. See the [Quickstart](#quickstart) section | ||
to add `google-cloud-orchestration-airflow` as a dependency in your code. | ||
|
||
## About Cloud Composer | ||
|
||
|
||
[Cloud Composer][product-docs] is a managed Apache Airflow service that helps you create, schedule, monitor and manage workflows. Cloud Composer automation helps you create Airflow environments quickly and use Airflow-native tools, such as the powerful Airflow web interface and command line tools, so you can focus on your workflows and not your infrastructure.", | ||
|
||
|
||
See the [Cloud Composer client library docs][javadocs] to learn how to | ||
use this Cloud Composer Client Library. | ||
|
||
## Troubleshooting | ||
|
||
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. | ||
|
||
## Transport | ||
|
||
Cloud Composer uses gRPC for the transport layer. | ||
|
||
## Java Versions | ||
|
||
Java 7 or above is required for using this client. | ||
|
||
## Versioning | ||
|
||
|
||
This library follows [Semantic Versioning](http://semver.org/). | ||
|
||
|
||
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. | ||
|
||
## Contributing | ||
|
||
|
||
Contributions to this library are always welcome and highly encouraged. | ||
|
||
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] | ||
|
||
Java is a registered trademark of Oracle and/or its affiliates. | ||
|
||
[product-docs]: https://cloud.google.com/composer/docs | ||
[javadocs]: https://googleapis.dev/java/google-cloud-orchestration-airflow/latest/index.html | ||
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/java7.svg | ||
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/java7.html | ||
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/java8.svg | ||
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/java8.html | ||
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/java8-osx.svg | ||
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/java8-osx.html | ||
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/java8-win.svg | ||
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/java8-win.html | ||
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/java11.svg | ||
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-orchestration-airflow/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-orchestration-airflow.svg | ||
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-orchestration-airflow&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-orchestration-airflow/blob/master/CONTRIBUTING.md | ||
[code-of-conduct]: https://github.com/googleapis/java-orchestration-airflow/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct | ||
[license]: https://github.com/googleapis/java-orchestration-airflow/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=orchestration-airflow.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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters