Skip to content

Commit 96d3835

Browse files
chore: regenerate README (#542)
This PR was generated using Autosynth. 🌈 <details><summary>Log from Synthtool</summary> ``` 2021-07-27 20:52:25,206 synthtool [DEBUG] > Executing /root/.cache/synthtool/java-spanner-jdbc/.github/readme/synth.py. On branch autosynth-readme nothing to commit, working tree clean 2021-07-27 20:52:26,466 synthtool [DEBUG] > Wrote metadata to .github/readme/synth.metadata/synth.metadata. ``` </details> Full log will be available here: https://source.cloud.google.com/results/invocations/7ded6de6-d25f-40c9-81f2-ea9cb5641798/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.)
1 parent 68125c4 commit 96d3835

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

.github/readme/synth.metadata/synth.metadata

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
"git": {
55
"name": ".",
66
"remote": "https://github.com/googleapis/java-spanner-jdbc.git",
7-
"sha": "a4bd82c8e4ce8b7179b943ac06b049598276f1b4"
7+
"sha": "68125c4d896a24f186d90648d3be64b5ad15aa37"
88
}
99
},
1010
{
1111
"git": {
1212
"name": "synthtool",
1313
"remote": "https://github.com/googleapis/synthtool.git",
14-
"sha": "959d4f81f2d1397297ebda90212df92aa0ef3a6a"
14+
"sha": "3d32990b6f4b57be77455e3ca89e6e21cd0c06b3"
1515
}
1616
}
1717
]

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ Java idiomatic client for [Google Cloud Spanner JDBC][product-docs].
88
- [Product Documentation][product-docs]
99
- [Client Library Documentation][javadocs]
1010

11+
1112
## Quickstart
1213

1314

1415
If you are using Maven, add this to your pom.xml file:
1516

17+
1618
```xml
1719
<dependency>
1820
<groupId>com.google.cloud</groupId>
@@ -22,11 +24,13 @@ If you are using Maven, add this to your pom.xml file:
2224
```
2325

2426
If you are using Gradle without BOM, add this to your dependencies
27+
2528
```Groovy
2629
compile 'com.google.cloud:google-cloud-spanner-jdbc:2.2.6'
2730
```
2831

2932
If you are using SBT, add this to your dependencies
33+
3034
```Scala
3135
libraryDependencies += "com.google.cloud" % "google-cloud-spanner-jdbc" % "2.2.6"
3236
```
@@ -35,6 +39,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-spanner-jdbc" % "2.2.6
3539

3640
See the [Authentication][authentication] section in the base directory's README.
3741

42+
## Authorization
43+
44+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Google Cloud Spanner JDBC APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Google Cloud Spanner JDBC API calls.
45+
3846
## Getting Started
3947

4048
### Prerequisites
@@ -178,6 +186,7 @@ and on [google-cloud-java][g-c-j].
178186
This library follows [Semantic Versioning](http://semver.org/).
179187

180188

189+
181190
## Contributing
182191

183192

@@ -189,6 +198,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
189198
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
190199
information.
191200

201+
192202
## License
193203

194204
Apache 2.0 - See [LICENSE][license] for more information.
@@ -220,6 +230,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
220230
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-spanner-jdbc.svg
221231
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-spanner-jdbc&core=gav
222232
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
233+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
234+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
235+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
223236
[developer-console]: https://console.developers.google.com/
224237
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
225238
[cloud-sdk]: https://cloud.google.com/sdk/

0 commit comments

Comments
 (0)