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

chore(docs): add Authorization section to Java README template (#1161) #25

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ Java idiomatic client for [Cloud Debugger][product-docs].
> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.


## Quickstart


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


```xml
<dependency>
<groupId>com.google.cloud</groupId>
Expand All @@ -25,11 +27,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-debugger-client:0.1.1'
```

If you are using SBT, add this to your dependencies

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-debugger-client" % "0.1.1"
```
Expand All @@ -38,6 +42,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-debugger-client" % "0.

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

## Getting Started

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


## Contributing


Expand All @@ -138,6 +147,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 @@ -170,6 +180,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-debugger-client.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-debugger-client&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