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

Commit

Permalink
chore: generate README from templates, update .repo-metadata.json (#77)
Browse files Browse the repository at this point in the history
  • Loading branch information
chingor13 committed Feb 4, 2020
1 parent 31a828a commit 746f5cf
Show file tree
Hide file tree
Showing 6 changed files with 64 additions and 870 deletions.
7 changes: 6 additions & 1 deletion .kokoro/linkage-monitor.sh
Expand Up @@ -23,7 +23,12 @@ cd github/java-asset/
java -version
echo ${JOB_TYPE}

mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgcloud.download.skip=true -B -V
mvn install -B -V \
-DskipTests=true \
-Dclirr.skip=true \
-Denforcer.skip=true \
-Dmaven.javadoc.skip=true \
-Dgcloud.download.skip=true

# Kokoro job cloud-opensource-java/ubuntu/linkage-monitor-gcs creates this JAR
JAR=linkage-monitor-latest-all-deps.jar
Expand Down
8 changes: 6 additions & 2 deletions .repo-metadata.json
@@ -1,10 +1,14 @@
{
"name": "cloudasset",
"name_pretty": "Cloud Asset",
"name_pretty": "Cloud Asset Inventory",
"product_documentation": "https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview",
"client_documentation": "https://googleapis.dev/java/java-asset/latest/index.html",
"api_reference": "https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview",
"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.",
"client_documentation": "https://googleapis.dev/java/google-cloud-asset/latest/index.html",
"issue_tracker": "https://issuetracker.google.com/issues/new?component=187210&template=0",
"release_level": "beta",
"transport": "grpc",
"requires_billing": true,
"language": "java",
"repo": "googleapis/java-asset",
"repo_short": "java-asset",
Expand Down
76 changes: 46 additions & 30 deletions README.md
@@ -1,6 +1,6 @@
# Google Cloud Java Client for Cloud Asset
# Google Cloud Asset Inventory Client for Java

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

[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]
Expand All @@ -12,34 +12,41 @@ Java idiomatic client for [Cloud Asset][api-reference].
> make backwards-incompatible changes.
## Quickstart
If you are using Maven with Bom, Add this to your pom.xml file.

If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>2.8.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>3.4.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-asset</artifactId>
</dependency>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-asset</artifactId>
</dependency>
</dependencies>
```

[//]: # ({x-version-update-start:google-cloud-asset:released})
If you are using Maven without Bom, Add this to your dependencies.

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

```xml
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-asset</artifactId>
<version>0.117.0-beta</version>
</dependency>
```

If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-asset:0.117.0-beta'
Expand All @@ -54,20 +61,13 @@ libraryDependencies += "com.google.cloud" % "google-cloud-asset" % "0.117.0-beta

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

## About Cloud Asset

[Cloud Asset][api-reference] is a suite of Machine Learning products.

See the [Cloud Asset client library docs][javadocs] to learn how to
use this Cloud Asset Client Library.

## Getting Started

### Prerequisites

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

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

## About Cloud Asset Inventory


[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.

See the [Cloud Asset Inventory client library docs][javadocs] to learn how to
use this Cloud Asset Inventory Client Library.




## Troubleshooting

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

## Transport

Cloud Asset uses gRPC for the transport layer.
Cloud Asset Inventory uses gRPC for the transport layer.

## Java Versions

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

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


Contributions to this library are always welcome and highly encouraged.

See [CONTRIBUTING.md][contributing] documentation for more information on how to get started.
See [CONTRIBUTING][contributing] for more information how to get started.

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

[api-reference]: https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview
[product-docs]: https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview
[javadocs]: https://googleapis.dev/java/google-cloud-asset/latest/index.html
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-asset/java7.svg
Expand All @@ -143,3 +156,6 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
[contributing]: https://github.com/googleapis/java-asset/blob/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-asset/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-asset/blob/master/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=cloudasset.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
3 changes: 2 additions & 1 deletion renovate.json
Expand Up @@ -22,7 +22,8 @@
"^com.google.api:gax",
"^com.google.auth:",
"^com.google.cloud:google-cloud-core",
"^io.grpc:"
"^io.grpc:",
"^com.google.guava:"
],
"groupName": "core dependencies"
},
Expand Down

0 comments on commit 746f5cf

Please sign in to comment.