Skip to content

Commit 1e28f15

Browse files
chore(docs): add Authorization section to Java README template (googleapis#1161) (googleapis#554)
as a part of the PR 582 for java-logging an authorization section is added to the Java README template. Fixing googleapis/java-logging#570. Source-Link: googleapis/synthtool@3d32990 Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7
1 parent 895dbe2 commit 1e28f15

2 files changed

Lines changed: 16 additions & 1 deletion

File tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
docker:
22
image: gcr.io/repo-automation-bots/owlbot-java:latest
3-
digest: sha256:b3f8a219abf58ed4a775da5b90934b34f477b74f6f4e5d15781694dcc67b6f41
3+
digest: sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7

java-resourcemanager/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ Java idiomatic client for [Resource Manager API][product-docs].
1111
> Note: This client is a work-in-progress, and may occasionally
1212
> make backwards-incompatible changes.
1313
14+
1415
## Quickstart
1516

1617
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
18+
1719
```xml
1820
<dependencyManagement>
1921
<dependencies>
@@ -37,6 +39,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
3739

3840
If you are using Maven without BOM, add this to your dependencies:
3941

42+
4043
```xml
4144
<dependency>
4245
<groupId>com.google.cloud</groupId>
@@ -47,17 +50,20 @@ If you are using Maven without BOM, add this to your dependencies:
4750
```
4851

4952
If you are using Gradle 5.x or later, add this to your dependencies
53+
5054
```Groovy
5155
implementation platform('com.google.cloud:libraries-bom:20.9.0')
5256
5357
compile 'com.google.cloud:google-cloud-resourcemanager'
5458
```
5559
If you are using Gradle without BOM, add this to your dependencies
60+
5661
```Groovy
5762
compile 'com.google.cloud:google-cloud-resourcemanager:0.119.8-alpha'
5863
```
5964

6065
If you are using SBT, add this to your dependencies
66+
6167
```Scala
6268
libraryDependencies += "com.google.cloud" % "google-cloud-resourcemanager" % "0.119.8-alpha"
6369
```
@@ -66,6 +72,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-resourcemanager" % "0.
6672

6773
See the [Authentication][authentication] section in the base directory's README.
6874

75+
## Authorization
76+
77+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Resource Manager API APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Resource Manager API API calls.
78+
6979
## Getting Started
7080

7181
### Prerequisites
@@ -296,6 +306,7 @@ This library follows [Semantic Versioning](http://semver.org/).
296306
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
297307
and the public API should not be considered stable.
298308

309+
299310
## Contributing
300311

301312

@@ -307,6 +318,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
307318
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
308319
information.
309320

321+
310322
## License
311323

312324
Apache 2.0 - See [LICENSE][license] for more information.
@@ -339,6 +351,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
339351
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-resourcemanager.svg
340352
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-resourcemanager&core=gav
341353
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
354+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
355+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
356+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
342357
[developer-console]: https://console.developers.google.com/
343358
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
344359
[cloud-sdk]: https://cloud.google.com/sdk/

0 commit comments

Comments
 (0)