From 82ac46fc13732599edd10f711bed582f512037c7 Mon Sep 17 00:00:00 2001 From: yoshi-automation Date: Tue, 27 Jul 2021 20:52:26 +0000 Subject: [PATCH] chore: regenerate README --- .github/readme/synth.metadata/synth.metadata | 4 ++-- README.md | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/.github/readme/synth.metadata/synth.metadata b/.github/readme/synth.metadata/synth.metadata index 62624f1ef..7c9be59dc 100644 --- a/.github/readme/synth.metadata/synth.metadata +++ b/.github/readme/synth.metadata/synth.metadata @@ -4,14 +4,14 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/java-datastore.git", - "sha": "fc8c1857d01515c50f6c2db4027cef650969e5ec" + "sha": "e7ad9750ec56459c08fdf829b56fd09d6e9635d6" } }, { "git": { "name": "synthtool", "remote": "https://github.com/googleapis/synthtool.git", - "sha": "dd05f9d12f134871c9e45282349c9856fbebecdd" + "sha": "3d32990b6f4b57be77455e3ca89e6e21cd0c06b3" } } ] diff --git a/README.md b/README.md index d73a5b2d1..bb9b78c26 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,11 @@ Java idiomatic client for [Cloud Datastore][product-docs]. - [Product Documentation][product-docs] - [Client Library Documentation][javadocs] + ## Quickstart If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file + ```xml @@ -34,6 +36,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file If you are using Maven without BOM, add this to your dependencies: + ```xml com.google.cloud @@ -44,17 +47,20 @@ If you are using Maven without BOM, add this to your dependencies: ``` If you are using Gradle 5.x or later, add this to your dependencies + ```Groovy implementation platform('com.google.cloud:libraries-bom:20.9.0') compile 'com.google.cloud:google-cloud-datastore' ``` If you are using Gradle without BOM, add this to your dependencies + ```Groovy compile 'com.google.cloud:google-cloud-datastore:1.107.1' ``` If you are using SBT, add this to your dependencies + ```Scala libraryDependencies += "com.google.cloud" % "google-cloud-datastore" % "1.107.1" ``` @@ -63,6 +69,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-datastore" % "1.107.1" See the [Authentication][authentication] section in the base directory's README. +## Authorization + +The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Cloud Datastore APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Cloud Datastore API calls. + ## Getting Started ### Prerequisites @@ -281,6 +291,7 @@ and on [google-cloud-java][g-c-j]. This library follows [Semantic Versioning](http://semver.org/). + ## Contributing @@ -292,6 +303,7 @@ Please note that this project is released with a Contributor Code of Conduct. By 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. @@ -324,6 +336,9 @@ Java is a registered trademark of Oracle and/or its affiliates. [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-datastore.svg [maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-datastore&core=gav [authentication]: https://github.com/googleapis/google-cloud-java#authentication +[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes +[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles +[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy [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/