Skip to content

Commit

Permalink
chore(docs): add Authorization section to Java README template (#1161) (
Browse files Browse the repository at this point in the history
#298)

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
  • Loading branch information
gcf-owl-bot[bot] authored Jul 28, 2021
1 parent c864950 commit 682bcc0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 1 addition & 1 deletion java-workflows/.github/.OwlBot.lock.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
docker:
image: gcr.io/repo-automation-bots/owlbot-java:latest
digest: sha256:b3f8a219abf58ed4a775da5b90934b34f477b74f6f4e5d15781694dcc67b6f41
digest: sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7
13 changes: 13 additions & 0 deletions java-workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ Java idiomatic client for [Cloud Workflows][product-docs].
- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]


## Quickstart


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


```xml
<dependency>
<groupId>com.google.cloud</groupId>
Expand All @@ -23,11 +25,13 @@ If you are using Maven, add this to your pom.xml file:
```

If you are using Gradle without BOM, add this to your dependencies

```Groovy
compile 'com.google.cloud:google-cloud-workflows:1.0.2'
```

If you are using SBT, add this to your dependencies

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-workflows" % "1.0.2"
```
Expand All @@ -36,6 +40,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-workflows" % "1.0.2"

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 Workflows APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Cloud Workflows API calls.

## Getting Started

### Prerequisites
Expand Down Expand Up @@ -122,6 +130,7 @@ and on [google-cloud-java][g-c-j].
This library follows [Semantic Versioning](http://semver.org/).



## Contributing


Expand All @@ -133,6 +142,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.
Expand Down Expand Up @@ -165,6 +175,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-workflows.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-workflows&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/
Expand Down

0 comments on commit 682bcc0

Please sign in to comment.