|
| 1 | +Google Cloud Java Client for Dataproc |
| 2 | +===================================== |
| 3 | + |
| 4 | +Java idiomatic client for [Google Cloud Dataproc][cloud-dataproc]. |
| 5 | + |
| 6 | +[](https://travis-ci.org/GoogleCloudPlatform/google-cloud-java) |
| 7 | +[](https://coveralls.io/r/GoogleCloudPlatform/google-cloud-java?branch=master) |
| 8 | +[]( https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-dataproc.svg) |
| 9 | +[](https://www.codacy.com/app/mziccard/google-cloud-java) |
| 10 | +[](https://www.versioneye.com/user/projects/58fe4c8d6ac171426c414772) |
| 11 | + |
| 12 | +- [Product Documentation][dataproc-product-docs] |
| 13 | +- [Client Library Documentation][dataproc-client-lib-docs] |
| 14 | + |
| 15 | +> Note: This client is a work-in-progress, and may occasionally |
| 16 | +> make backwards-incompatible changes. |
| 17 | +
|
| 18 | +Quickstart |
| 19 | +---------- |
| 20 | + |
| 21 | +Add this to your pom.xml file |
| 22 | +```xml |
| 23 | +<dependency> |
| 24 | + <groupId>com.google.cloud</groupId> |
| 25 | + <artifactId>google-cloud-dataproc</artifactId> |
| 26 | + <version>0.32.0-alpha</version> |
| 27 | +</dependency> |
| 28 | +``` |
| 29 | +If you are using Gradle, add this to your dependencies |
| 30 | +```Groovy |
| 31 | +compile 'com.google.cloud:google-cloud-dataproc:0.32.0-alpha' |
| 32 | +``` |
| 33 | +If you are using SBT, add this to your dependencies |
| 34 | +```Scala |
| 35 | +libraryDependencies += "com.google.cloud" % "google-cloud-dataproc" % "0.32.0-alpha" |
| 36 | +``` |
| 37 | + |
| 38 | +Authentication |
| 39 | +-------------- |
| 40 | + |
| 41 | +See the [Authentication](https://github.com/GoogleCloudPlatform/google-cloud-java#authentication) section in the base directory's README. |
| 42 | + |
| 43 | +About Google Cloud Dataproc |
| 44 | +--------------------------- |
| 45 | + |
| 46 | +[Google Cloud Dataproc][cloud-dataproc] manages Hadoop-based clusters and jobs on Google Cloud |
| 47 | +Platform. |
| 48 | + |
| 49 | +See the [Google Cloud Dataproc docs][cloud-dataproc-quickstart] for more details on how to activate |
| 50 | +Cloud Dataproc for your project. |
| 51 | + |
| 52 | +See the [Dataproc client library docs][dataproc-client-lib-docs] to learn how to interact with the |
| 53 | +Cloud Dataproc using this Client Library. |
| 54 | + |
| 55 | +Getting Started |
| 56 | +--------------- |
| 57 | +#### Prerequisites |
| 58 | +For this tutorial, you will need a |
| 59 | +[Google Developers Console](https://console.developers.google.com/) project with the Dataproc API |
| 60 | +enabled. You will need to [enable billing](https://support.google.com/cloud/answer/6158867?hl=en) to |
| 61 | +use Google Cloud Dataproc. |
| 62 | +[Follow these instructions](https://cloud.google.com/docs/authentication#preparation) to get your |
| 63 | +project set up. [Set up authentication with a service account][auth] so you can access the |
| 64 | +API from your local workstation. |
| 65 | + |
| 66 | +#### Installation and setup |
| 67 | +You'll need to obtain the `google-cloud-dataproc` library. See the [Quickstart](#quickstart) section |
| 68 | +to add `google-cloud-dataproc` as a dependency in your code. |
| 69 | + |
| 70 | +Transport |
| 71 | +--------- |
| 72 | +Dataproc uses gRPC for the transport layer. |
| 73 | + |
| 74 | +Java Versions |
| 75 | +------------- |
| 76 | + |
| 77 | +Java 7 or above is required for using this client. |
| 78 | + |
| 79 | +Testing |
| 80 | +------- |
| 81 | + |
| 82 | +This library has tools to help make tests for code using Cloud Dataproc. |
| 83 | + |
| 84 | +See [TESTING] to read more about testing. |
| 85 | + |
| 86 | +Versioning |
| 87 | +---------- |
| 88 | + |
| 89 | +This library follows [Semantic Versioning](http://semver.org/). |
| 90 | + |
| 91 | +It is currently in major version zero (``0.y.z``), which means that anything |
| 92 | +may change at any time and the public API should not be considered |
| 93 | +stable. |
| 94 | + |
| 95 | +Contributing |
| 96 | +------------ |
| 97 | + |
| 98 | +Contributions to this library are always welcome and highly encouraged. |
| 99 | + |
| 100 | +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. |
| 101 | + |
| 102 | +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. |
| 103 | + |
| 104 | +License |
| 105 | +------- |
| 106 | + |
| 107 | +Apache 2.0 - See [LICENSE] for more information. |
| 108 | + |
| 109 | + |
| 110 | +[CONTRIBUTING]:https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/CONTRIBUTING.md |
| 111 | +[code-of-conduct]:https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct |
| 112 | +[LICENSE]: https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/LICENSE |
| 113 | +[TESTING]: https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/TESTING.md |
| 114 | + |
| 115 | +[cloud-dataproc]: https://cloud.google.com/dataproc/ |
| 116 | +[cloud-dataproc-quickstart]: https://cloud.google.com/dataproc/quickstart-console#before-you-begin |
| 117 | +[dataproc-product-docs]: https://cloud.google.com/dataproc/docs/ |
| 118 | +[dataproc-client-lib-docs]: https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/index.html?com/google/cloud/dataproc/v1/package-summary.html |
| 119 | +[auth]: https://cloud.google.com/docs/authentication/getting-started |
0 commit comments