Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit 034e78d

Browse files
chore(docs): add Authorization section to Java README template (#1161) (#189)
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 dee9115 commit 034e78d

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

.github/.OwlBot.lock.yaml

+1-1
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

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ Java idiomatic client for [Video Transcoder][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

1718
If you are using Maven, add this to your pom.xml file:
1819

20+
1921
```xml
2022
<dependency>
2123
<groupId>com.google.cloud</groupId>
@@ -25,11 +27,13 @@ If you are using Maven, add this to your pom.xml file:
2527
```
2628

2729
If you are using Gradle without BOM, add this to your dependencies
30+
2831
```Groovy
2932
compile 'com.google.cloud:google-cloud-video-transcoder:0.2.0'
3033
```
3134

3235
If you are using SBT, add this to your dependencies
36+
3337
```Scala
3438
libraryDependencies += "com.google.cloud" % "google-cloud-video-transcoder" % "0.2.0"
3539
```
@@ -38,6 +42,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-video-transcoder" % "0
3842

3943
See the [Authentication][authentication] section in the base directory's README.
4044

45+
## Authorization
46+
47+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Video Transcoder APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Video Transcoder API calls.
48+
4149
## Getting Started
4250

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

138+
130139
## Contributing
131140

132141

@@ -138,6 +147,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
138147
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
139148
information.
140149

150+
141151
## License
142152

143153
Apache 2.0 - See [LICENSE][license] for more information.
@@ -170,6 +180,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
170180
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-video-transcoder.svg
171181
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-video-transcoder&core=gav
172182
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
183+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
184+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
185+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
173186
[developer-console]: https://console.developers.google.com/
174187
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
175188
[cloud-sdk]: https://cloud.google.com/sdk/

0 commit comments

Comments
 (0)