From b7b680d26089d0cdd54d519861c8b30a475ed1f3 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 28 Jul 2021 00:50:46 +0000 Subject: [PATCH] chore(docs): add Authorization section to Java README template (#1161) (#108) 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: https://github.com/googleapis/synthtool/commit/3d32990b6f4b57be77455e3ca89e6e21cd0c06b3 Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7 --- .github/.OwlBot.lock.yaml | 2 +- README.md | 13 +++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index 906e06f..419ccb9 100644 --- a/.github/.OwlBot.lock.yaml +++ b/.github/.OwlBot.lock.yaml @@ -1,3 +1,3 @@ docker: - digest: sha256:b3f8a219abf58ed4a775da5b90934b34f477b74f6f4e5d15781694dcc67b6f41 image: gcr.io/repo-automation-bots/owlbot-java:latest + digest: sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7 diff --git a/README.md b/README.md index ae547d0..d2436be 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,13 @@ Java idiomatic client for [Cloud Profiler][product-docs]. - [Product Documentation][product-docs] - [Client Library Documentation][javadocs] + ## Quickstart If you are using Maven, add this to your pom.xml file: + ```xml com.google.cloud @@ -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-profiler:1.1.2' ``` If you are using SBT, add this to your dependencies + ```Scala libraryDependencies += "com.google.cloud" % "google-cloud-profiler" % "1.1.2" ``` @@ -36,6 +40,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-profiler" % "1.1.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 Profiler APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Cloud Profiler API calls. + ## Getting Started ### Prerequisites @@ -122,6 +130,7 @@ and on [google-cloud-java][g-c-j]. This library follows [Semantic Versioning](http://semver.org/). + ## Contributing @@ -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. @@ -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-profiler.svg [maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-profiler&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/