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

Commit 746f5cf

Browse files
authored
chore: generate README from templates, update .repo-metadata.json (#77)
1 parent 31a828a commit 746f5cf

File tree

6 files changed

+64
-870
lines changed

6 files changed

+64
-870
lines changed

.kokoro/linkage-monitor.sh

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,12 @@ cd github/java-asset/
2323
java -version
2424
echo ${JOB_TYPE}
2525

26-
mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgcloud.download.skip=true -B -V
26+
mvn install -B -V \
27+
-DskipTests=true \
28+
-Dclirr.skip=true \
29+
-Denforcer.skip=true \
30+
-Dmaven.javadoc.skip=true \
31+
-Dgcloud.download.skip=true
2732

2833
# Kokoro job cloud-opensource-java/ubuntu/linkage-monitor-gcs creates this JAR
2934
JAR=linkage-monitor-latest-all-deps.jar

.repo-metadata.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
{
22
"name": "cloudasset",
3-
"name_pretty": "Cloud Asset",
3+
"name_pretty": "Cloud Asset Inventory",
44
"product_documentation": "https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview",
5-
"client_documentation": "https://googleapis.dev/java/java-asset/latest/index.html",
5+
"api_reference": "https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview",
6+
"api_description": "provides inventory services based on a time series database. This database keeps a five week history of Google Cloud asset metadata. The Cloud Asset Inventory export service allows you to export all asset metadata at a certain timestamp or export event change history during a timeframe.",
7+
"client_documentation": "https://googleapis.dev/java/google-cloud-asset/latest/index.html",
68
"issue_tracker": "https://issuetracker.google.com/issues/new?component=187210&template=0",
79
"release_level": "beta",
10+
"transport": "grpc",
11+
"requires_billing": true,
812
"language": "java",
913
"repo": "googleapis/java-asset",
1014
"repo_short": "java-asset",

README.md

Lines changed: 46 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Google Cloud Java Client for Cloud Asset
1+
# Google Cloud Asset Inventory Client for Java
22

3-
Java idiomatic client for [Cloud Asset][api-reference].
3+
Java idiomatic client for [Cloud Asset Inventory][product-docs].
44

55
[![Maven][maven-version-image]][maven-version-link]
66
![Stability][stability-image]
@@ -12,34 +12,41 @@ Java idiomatic client for [Cloud Asset][api-reference].
1212
> make backwards-incompatible changes.
1313
1414
## Quickstart
15-
If you are using Maven with Bom, Add this to your pom.xml file.
15+
16+
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
1617
```xml
1718
<dependencyManagement>
18-
<dependencies>
19-
<dependency>
20-
<groupId>com.google.cloud</groupId>
21-
<artifactId>libraries-bom</artifactId>
22-
<version>2.8.0</version>
23-
<type>pom</type>
24-
<scope>import</scope>
25-
</dependency>
26-
</dependencies>
19+
<dependencies>
20+
<dependency>
21+
<groupId>com.google.cloud</groupId>
22+
<artifactId>libraries-bom</artifactId>
23+
<version>3.4.0</version>
24+
<type>pom</type>
25+
<scope>import</scope>
26+
</dependency>
27+
</dependencies>
2728
</dependencyManagement>
2829

29-
<dependency>
30-
<groupId>com.google.cloud</groupId>
31-
<artifactId>google-cloud-asset</artifactId>
32-
</dependency>
30+
<dependencies>
31+
<dependency>
32+
<groupId>com.google.cloud</groupId>
33+
<artifactId>google-cloud-asset</artifactId>
34+
</dependency>
35+
</dependencies>
3336
```
37+
3438
[//]: # ({x-version-update-start:google-cloud-asset:released})
35-
If you are using Maven without Bom, Add this to your dependencies.
39+
40+
If you are using Maven without BOM, add this to your dependencies:
41+
3642
```xml
3743
<dependency>
3844
<groupId>com.google.cloud</groupId>
3945
<artifactId>google-cloud-asset</artifactId>
4046
<version>0.117.0-beta</version>
4147
</dependency>
4248
```
49+
4350
If you are using Gradle, add this to your dependencies
4451
```Groovy
4552
compile 'com.google.cloud:google-cloud-asset:0.117.0-beta'
@@ -54,20 +61,13 @@ libraryDependencies += "com.google.cloud" % "google-cloud-asset" % "0.117.0-beta
5461

5562
See the [Authentication][authentication] section in the base directory's README.
5663

57-
## About Cloud Asset
58-
59-
[Cloud Asset][api-reference] is a suite of Machine Learning products.
60-
61-
See the [Cloud Asset client library docs][javadocs] to learn how to
62-
use this Cloud Asset Client Library.
63-
6464
## Getting Started
6565

6666
### Prerequisites
6767

68-
You will need a [Google Developers Console][developer-console] project with the
69-
Cloud Asset API enabled. [Follow these instructions][create-project] to get your
70-
project set up. You will also need to set up the local development environment by
68+
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Asset Inventory [API enabled][enable-api].
69+
You will need to [enable billing][enable-billing] to use Google Cloud Asset Inventory.
70+
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
7171
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
7272
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
7373

@@ -76,13 +76,24 @@ project set up. You will also need to set up the local development environment b
7676
You'll need to obtain the `google-cloud-asset` library. See the [Quickstart](#quickstart) section
7777
to add `google-cloud-asset` as a dependency in your code.
7878

79+
## About Cloud Asset Inventory
80+
81+
82+
[Cloud Asset Inventory][product-docs] provides inventory services based on a time series database. This database keeps a five week history of Google Cloud asset metadata. The Cloud Asset Inventory export service allows you to export all asset metadata at a certain timestamp or export event change history during a timeframe.
83+
84+
See the [Cloud Asset Inventory client library docs][javadocs] to learn how to
85+
use this Cloud Asset Inventory Client Library.
86+
87+
88+
89+
7990
## Troubleshooting
8091

8192
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
8293

8394
## Transport
8495

85-
Cloud Asset uses gRPC for the transport layer.
96+
Cloud Asset Inventory uses gRPC for the transport layer.
8697

8798
## Java Versions
8899

@@ -92,14 +103,17 @@ Java 7 or above is required for using this client.
92103

93104
This library follows [Semantic Versioning](http://semver.org/).
94105

106+
95107
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
96108
and the public API should not be considered stable.
97109

110+
98111
## Contributing
99112

113+
100114
Contributions to this library are always welcome and highly encouraged.
101115

102-
See [CONTRIBUTING.md][contributing] documentation for more information on how to get started.
116+
See [CONTRIBUTING][contributing] for more information how to get started.
103117

104118
Please note that this project is released with a Contributor Code of Conduct. By participating in
105119
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
@@ -119,7 +133,6 @@ Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
119133
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
120134
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
121135

122-
[api-reference]: https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview
123136
[product-docs]: https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview
124137
[javadocs]: https://googleapis.dev/java/google-cloud-asset/latest/index.html
125138
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-asset/java7.svg
@@ -143,3 +156,6 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
143156
[contributing]: https://github.com/googleapis/java-asset/blob/master/CONTRIBUTING.md
144157
[code-of-conduct]: https://github.com/googleapis/java-asset/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
145158
[license]: https://github.com/googleapis/java-asset/blob/master/LICENSE
159+
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
160+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=cloudasset.googleapis.com
161+
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM

renovate.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
"^com.google.api:gax",
2323
"^com.google.auth:",
2424
"^com.google.cloud:google-cloud-core",
25-
"^io.grpc:"
25+
"^io.grpc:",
26+
"^com.google.guava:"
2627
],
2728
"groupName": "core dependencies"
2829
},

0 commit comments

Comments
 (0)