1# Google Cloud Auto ML Client for Java 2 3Java idiomatic client for [Cloud Auto ML][product-docs]. 4 5[![Maven][maven-version-image]][maven-version-link] 6![Stability][stability-image] 7 8- [Product Documentation][product-docs] 9- [Client Library Documentation][javadocs] 10 11 12## Quickstart 13 14 15If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file: 16 17```xml 18<dependencyManagement> 19 <dependencies> 20 <dependency> 21 <groupId>com.google.cloud</groupId> 22 <artifactId>libraries-bom</artifactId> 23 <version>26.11.0</version> 24 <type>pom</type> 25 <scope>import</scope> 26 </dependency> 27 </dependencies> 28</dependencyManagement> 29 30<dependencies> 31 <dependency> 32 <groupId>com.google.cloud</groupId> 33 <artifactId>google-cloud-automl</artifactId> 34 </dependency> 35``` 36 37If you are using Maven without the BOM, add this to your dependencies: 38 39<!-- {x-version-update-start:google-cloud-automl:released} --> 40 41```xml 42<dependency> 43 <groupId>com.google.cloud</groupId> 44 <artifactId>google-cloud-automl</artifactId> 45 <version>2.17.0</version> 46</dependency> 47``` 48 49If you are using Gradle without BOM, add this to your dependencies: 50 51```Groovy 52implementation 'com.google.cloud:google-cloud-automl:2.17.0' 53``` 54 55If you are using SBT, add this to your dependencies: 56 57```Scala 58libraryDependencies += "com.google.cloud" % "google-cloud-automl" % "2.17.0" 59``` 60<!-- {x-version-update-end} --> 61 62## Authentication 63 64See the [Authentication][authentication] section in the base directory's README. 65 66## Authorization 67 68The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Cloud Auto ML APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Cloud Auto ML API calls. 69 70## Getting Started 71 72### Prerequisites 73 74You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Auto ML [API enabled][enable-api]. 75You will need to [enable billing][enable-billing] to use Google Cloud Auto ML. 76[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by 77[installing the Google Cloud Command Line Interface][cloud-cli] and running the following commands in command line: 78`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`. 79 80### Installation and setup 81 82You'll need to obtain the `google-cloud-automl` library. See the [Quickstart](#quickstart) section 83to add `google-cloud-automl` as a dependency in your code. 84 85## About Cloud Auto ML 86 87 **AutoML API Java Client is now available in Vertex AI. Please visit** 88[java-aiplatform](https://github.com/googleapis/java-aiplatform) **for the new Java Vertex AI client.** 89Vertex AI is our next generation AI Platform, with many new features that are unavailable in the current platform. 90[Migrate your resources to Vertex AI](https://cloud.google.com/vertex-ai/docs/start/migrating-to-vertex-ai) to get 91the latest machine learning features, simplify end-to-end journeys, and productionize models with MLOps. 92 93[Cloud Auto ML](https://cloud.google.com/automl/docs/) makes the power 94of machine learning available to you even if you have limited knowledge 95of machine learning. You can use AutoML to build on Google's machine 96learning capabilities to create your own custom machine learning models 97that are tailored to your business needs, and then integrate those 98models into your applications and web sites. 99 100See the [Cloud Auto ML client library docs](https://cloud.google.com/java/docs/reference/google-cloud-automl/latest/overview) 101to learn how to use this Cloud Auto ML Client Library. 102 103 104 105 106 107 108 109## Troubleshooting 110 111To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. 112 113## Transport 114 115Cloud Auto ML uses gRPC for the transport layer. 116 117## Supported Java Versions 118 119Java 8 or above is required for using this client. 120 121Google's Java client libraries, 122[Google Cloud Client Libraries][cloudlibs] 123and 124[Google Cloud API Libraries][apilibs], 125follow the 126[Oracle Java SE support roadmap][oracle] 127(see the Oracle Java SE Product Releases section). 128 129### For new development 130 131In general, new feature development occurs with support for the lowest Java 132LTS version covered by Oracle's Premier Support (which typically lasts 5 years 133from initial General Availability). If the minimum required JVM for a given 134library is changed, it is accompanied by a [semver][semver] major release. 135 136Java 11 and (in September 2021) Java 17 are the best choices for new 137development. 138 139### Keeping production systems current 140 141Google tests its client libraries with all current LTS versions covered by 142Oracle's Extended Support (which typically lasts 8 years from initial 143General Availability). 144 145#### Legacy support 146 147Google's client libraries support legacy versions of Java runtimes with long 148term stable libraries that don't receive feature updates on a best efforts basis 149as it may not be possible to backport all patches. 150 151Google provides updates on a best efforts basis to apps that continue to use 152Java 7, though apps might need to upgrade to current versions of the library 153that supports their JVM. 154 155#### Where to find specific information 156 157The latest versions and the supported Java versions are identified on 158the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME` 159and on [google-cloud-java][g-c-j]. 160 161## Versioning 162 163 164This library follows [Semantic Versioning](http://semver.org/). 165 166 167 168## Contributing 169 170 171Contributions to this library are always welcome and highly encouraged. 172 173See [CONTRIBUTING][contributing] for more information how to get started. 174 175Please note that this project is released with a Contributor Code of Conduct. By participating in 176this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more 177information. 178 179 180## License 181 182Apache 2.0 - See [LICENSE][license] for more information. 183 184## CI Status 185 186Java Version | Status 187------------ | ------ 188Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2] 189Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3] 190Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4] 191Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] 192 193Java is a registered trademark of Oracle and/or its affiliates. 194 195[product-docs]: https://cloud.google.com/automl/docs/ 196[javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-automl/latest/overview 197[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.svg 198[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.html 199[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.svg 200[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.html 201[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.svg 202[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.html 203[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.svg 204[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.html 205[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.svg 206[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html 207[stability-image]: https://img.shields.io/badge/stability-stable-green 208[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-automl.svg 209[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-automl/2.14.0 210[authentication]: https://github.com/googleapis/google-cloud-java#authentication 211[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes 212[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles 213[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy 214[developer-console]: https://console.developers.google.com/ 215[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects 216[cloud-cli]: https://cloud.google.com/cli 217[troubleshooting]: https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md 218[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md 219[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct 220[license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE 221[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing 222[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=automl.googleapis.com 223[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM 224[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png 225 226[semver]: https://semver.org/ 227[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained 228[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries 229[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html 230[g-c-j]: http://github.com/googleapis/google-cloud-java 231