|
| 1 | +Google Cloud Java Client for Cloud Tasks |
| 2 | +====================================== |
| 3 | + |
| 4 | +Java idiomatic client for [Cloud Tasks][cloud-tasks]. |
| 5 | + |
| 6 | +[](https://circleci.com/gh/GoogleCloudPlatform/google-cloud-java/tree/master) |
| 7 | +[](https://coveralls.io/r/GoogleCloudPlatform/google-cloud-java?branch=master) |
| 8 | +[](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-tasks.svg) |
| 9 | +[](https://www.codacy.com/app/mziccard/google-cloud-java) |
| 10 | +[](https://www.versioneye.com/user/projects/58fe4c8d6ac171426c414772) |
| 11 | + |
| 12 | +- [Product Documentation][tasks] |
| 13 | +- [Client Library Documentation][tasks] |
| 14 | + |
| 15 | +> Note: This client is a work-in-progress, and may occasionally |
| 16 | +> make backwards-incompatible changes. |
| 17 | +
|
| 18 | +Quickstart |
| 19 | +---------- |
| 20 | + |
| 21 | +[//]: # ({x-version-update-start:google-cloud-tasks:released}) |
| 22 | +If you are using Maven, add this to your pom.xml file |
| 23 | +```xml |
| 24 | +<dependency> |
| 25 | + <groupId>com.google.cloud</groupId> |
| 26 | + <artifactId>google-cloud-tasks</artifactId> |
| 27 | + <version>0.53.0-beta</version> |
| 28 | +</dependency> |
| 29 | +``` |
| 30 | +If you are using Gradle, add this to your dependencies |
| 31 | +```Groovy |
| 32 | +compile 'com.google.cloud:google-cloud-tasks:0.53.0-beta' |
| 33 | +``` |
| 34 | +If you are using SBT, add this to your dependencies |
| 35 | +```Scala |
| 36 | +libraryDependencies += "com.google.cloud" % "google-cloud-tasks" % "0.53.0-beta" |
| 37 | +``` |
| 38 | +[//]: # ({x-version-update-end}) |
| 39 | + |
| 40 | +Authentication |
| 41 | +-------------- |
| 42 | + |
| 43 | +See the [Authentication](https://github.com/GoogleCloudPlatform/google-cloud-java#authentication) section in the base directory's README. |
| 44 | + |
| 45 | +About Google Cloud Cloud Tasks |
| 46 | +---------------------------- |
| 47 | + |
| 48 | +Google [Cloud Tasks API][cloud-tasks] manages Cloud Tasks queues and tasks. |
| 49 | + |
| 50 | +See the [Cloud Tasks client library docs][tasks] to learn how to use this Cloud Tasks API Client Library. |
| 51 | + |
| 52 | +Getting Started |
| 53 | +--------------- |
| 54 | +#### Prerequisites |
| 55 | +You will need a [Google Developers Console](https://console.developers.google.com/) project with the Cloud Tasks API enabled. [Follow these instructions](https://cloud.google.com/docs/authentication#preparation) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`. |
| 56 | + |
| 57 | +#### Installation and setup |
| 58 | +You'll need to obtain the `google-cloud-tasks` library. See the [Quickstart](#quickstart) section to add `google-cloud-tasks` as a dependency in your code. |
| 59 | + |
| 60 | +Troubleshooting |
| 61 | +--------------- |
| 62 | + |
| 63 | +To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting). |
| 64 | + |
| 65 | +Transport |
| 66 | +--------- |
| 67 | +Cloud Tasks uses gRPC for the transport layer. |
| 68 | + |
| 69 | +Java Versions |
| 70 | +------------- |
| 71 | + |
| 72 | +Java 7 or above is required for using this client. |
| 73 | + |
| 74 | +Versioning |
| 75 | +---------- |
| 76 | + |
| 77 | +This library follows [Semantic Versioning](http://semver.org/). |
| 78 | + |
| 79 | +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. |
| 80 | + |
| 81 | +Contributing |
| 82 | +------------ |
| 83 | + |
| 84 | +Contributions to this library are always welcome and highly encouraged. |
| 85 | + |
| 86 | +See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started. |
| 87 | + |
| 88 | +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. |
| 89 | + |
| 90 | +License |
| 91 | +------- |
| 92 | + |
| 93 | +Apache 2.0 - See [LICENSE] for more information. |
| 94 | + |
| 95 | + |
| 96 | +[CONTRIBUTING]:https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/CONTRIBUTING.md |
| 97 | +[code-of-conduct]:https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct |
| 98 | +[LICENSE]: https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/LICENSE |
| 99 | +[cloud-platform]: https://cloud.google.com/ |
| 100 | +[cloud-tasks]: https://cloud.google.com/tasks |
| 101 | +[tasks]: https://cloud.google.com/tasks/docs |
| 102 | +[tasks]: https://googlecloudplatform.github.io/google-cloud-java/google-cloud-clients/apidocs/index.html?com/google/cloud/tasks/v2beta2/package-summary.html |
0 commit comments