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

Commit ddeef05

Browse files
chore: regenerate README (#598)
This PR was generated using Autosynth. 🌈 <details><summary>Log from Synthtool</summary> ``` 2021-07-27 20:56:02,612 synthtool [DEBUG] > Executing /root/.cache/synthtool/java-errorreporting/.github/readme/synth.py. On branch autosynth-readme nothing to commit, working tree clean 2021-07-27 20:56:04,195 synthtool [DEBUG] > Wrote metadata to .github/readme/synth.metadata/synth.metadata. ``` </details> Full log will be available here: https://source.cloud.google.com/results/invocations/4b16580f-20ab-4553-aba2-f32e89bdabd2/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.)
1 parent 7a1cde4 commit ddeef05

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

.github/readme/synth.metadata/synth.metadata

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
"git": {
55
"name": ".",
66
"remote": "https://github.com/googleapis/java-errorreporting.git",
7-
"sha": "db339de20b2794ed64ebd0b7f333256fff7b211b"
7+
"sha": "7a1cde40dc755fb2dc06eb95458880c1d91e28c3"
88
}
99
},
1010
{
1111
"git": {
1212
"name": "synthtool",
1313
"remote": "https://github.com/googleapis/synthtool.git",
14-
"sha": "4124d245133c0f740ac5e6fa2e7daeba327f1297"
14+
"sha": "3d32990b6f4b57be77455e3ca89e6e21cd0c06b3"
1515
}
1616
}
1717
]

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ Java idiomatic client for [Cloud Error Reporting][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>
@@ -56,6 +58,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
5658

5759
If you are using Maven without BOM, add this to your dependencies:
5860

61+
5962
```xml
6063
<dependency>
6164
<groupId>com.google.cloud</groupId>
@@ -66,17 +69,20 @@ If you are using Maven without BOM, add this to your dependencies:
6669
```
6770

6871
If you are using Gradle 5.x or later, add this to your dependencies
72+
6973
```Groovy
70-
implementation platform('com.google.cloud:libraries-bom:20.8.0')
74+
implementation platform('com.google.cloud:libraries-bom:20.9.0')
7175
7276
compile 'com.google.cloud:google-cloud-errorreporting'
7377
```
7478
If you are using Gradle without BOM, add this to your dependencies
79+
7580
```Groovy
7681
compile 'com.google.cloud:google-cloud-errorreporting:0.121.4-beta'
7782
```
7883

7984
If you are using SBT, add this to your dependencies
85+
8086
```Scala
8187
libraryDependencies += "com.google.cloud" % "google-cloud-errorreporting" % "0.121.4-beta"
8288
```
@@ -85,6 +91,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-errorreporting" % "0.1
8591

8692
See the [Authentication][authentication] section in the base directory's README.
8793

94+
## Authorization
95+
96+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Cloud Error Reporting APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Cloud Error Reporting API calls.
97+
8898
## Getting Started
8999

90100
### Prerequisites
@@ -114,8 +124,7 @@ use this Cloud Error Reporting Client Library.
114124

115125
## Samples
116126

117-
Samples are in the [`samples/`](https://github.com/googleapis/java-errorreporting/tree/master/samples) directory. The samples' `README.md`
118-
has instructions for running the samples.
127+
Samples are in the [`samples/`](https://github.com/googleapis/java-errorreporting/tree/master/samples) directory.
119128

120129
| Sample | Source Code | Try it |
121130
| --------------------------- | --------------------------------- | ------ |
@@ -184,6 +193,7 @@ This library follows [Semantic Versioning](http://semver.org/).
184193
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
185194
and the public API should not be considered stable.
186195

196+
187197
## Contributing
188198

189199

@@ -195,6 +205,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
195205
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
196206
information.
197207

208+
198209
## License
199210

200211
Apache 2.0 - See [LICENSE][license] for more information.
@@ -227,6 +238,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
227238
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-errorreporting.svg
228239
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-errorreporting&core=gav
229240
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
241+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
242+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
243+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
230244
[developer-console]: https://console.developers.google.com/
231245
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
232246
[cloud-sdk]: https://cloud.google.com/sdk/

0 commit comments

Comments
 (0)