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

Commit 49ea644

Browse files
chingor13chingor13
authored
feat: promote to beta (#64)
1 parent 36b194d commit 49ea644

File tree

4 files changed

+488
-543
lines changed

4 files changed

+488
-543
lines changed

‎.repo-metadata.json

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
{
22
"name": "datalabeling",
33
"name_pretty": "Google Cloud Data Labeling",
4-
"product_documentation": "https://cloud.google.com/data-labeling/docs/",
5-
"client_documentation": "https://googleapis.dev/java/java-datalabeling/latest/index.html",
4+
"product_documentation": "https://cloud.google.com/ai-platform/data-labeling/docs/",
5+
"client_documentation": "https://googleapis.dev/java/google-cloud-datalabeling/latest/index.html",
6+
"api_description": "",
67
"issue_tracker": "",
7-
"release_level": "alpha",
8+
"release_level": "beta",
89
"language": "java",
10+
"transport": "grpc",
911
"repo": "googleapis/java-datalabeling",
1012
"repo_short": "java-datalabeling",
1113
"distribution_name": "com.google.cloud:google-cloud-datalabeling",

‎README.md

+104-65
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,52 @@
1-
Google Cloud Java Client for Cloud Data Labeling
2-
===================================================
1+
# Google Google Cloud Data Labeling Client for Java
32

4-
Java idiomatic client for [Cloud Data Labeling][cloud-datalabeling].
3+
Java idiomatic client for [Google Cloud Data Labeling][product-docs].
54

6-
[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.html)
7-
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-datalabeling.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-datalabeling.svg)
8-
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
5+
[![Maven][maven-version-image]][maven-version-link]
6+
![Stability][stability-image]
97

10-
- [Product Documentation][datalabeling-product-docs]
11-
- [Client Library Documentation][datalabeling-lib-docs]
8+
- [Product Documentation][product-docs]
9+
- [Client Library Documentation][javadocs]
1210

1311
> Note: This client is a work-in-progress, and may occasionally
1412
> make backwards-incompatible changes.
1513
16-
Quickstart
17-
----------
18-
If you are using Maven with Bom, Add this to your pom.xml file.
14+
## Quickstart
15+
16+
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
1917
```xml
2018
<dependencyManagement>
21-
<dependencies>
22-
<dependency>
23-
<groupId>com.google.cloud</groupId>
24-
<artifactId>libraries-bom</artifactId>
25-
<version>2.8.0</version>
26-
<type>pom</type>
27-
<scope>import</scope>
28-
</dependency>
29-
</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>
3028
</dependencyManagement>
3129

32-
<dependency>
33-
<groupId>com.google.cloud</groupId>
34-
<artifactId>google-cloud-datalabeling</artifactId>
35-
</dependency>
30+
<dependencies>
31+
<dependency>
32+
<groupId>com.google.cloud</groupId>
33+
<artifactId>google-cloud-datalabeling</artifactId>
34+
</dependency>
35+
</dependencies>
3636
```
37+
3738
[//]: # ({x-version-update-start:google-cloud-datalabeling:released})
38-
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+
3942
```xml
4043
<dependency>
4144
<groupId>com.google.cloud</groupId>
4245
<artifactId>google-cloud-datalabeling</artifactId>
4346
<version>0.116.3-alpha</version>
4447
</dependency>
4548
```
49+
4650
If you are using Gradle, add this to your dependencies
4751
```Groovy
4852
compile 'com.google.cloud:google-cloud-datalabeling:0.116.3-alpha'
@@ -53,64 +57,99 @@ libraryDependencies += "com.google.cloud" % "google-cloud-datalabeling" % "0.116
5357
```
5458
[//]: # ({x-version-update-end})
5559

56-
Authentication
57-
--------------
60+
## Authentication
5861

59-
See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
62+
See the [Authentication][authentication] section in the base directory's README.
6063

61-
About Cloud Labeling
62-
----------------------------
64+
## Getting Started
6365

64-
See the [Cloud Data Labeling client library docs][datalabeling-lib-docs] to learn how to use this Cloud Data Labeling Client Library.
66+
### Prerequisites
6567

66-
Getting Started
67-
---------------
68-
#### Prerequisites
69-
You will need a [Google Developers Console](https://console.developers.google.com/) project with the Cloud Data Labeling API enabled. [Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
68+
You will need a [Google Cloud Platform Console][developer-console] project with the Google Cloud Data Labeling [API enabled][enable-api].
7069

71-
#### Installation and setup
72-
You'll need to obtain the `google-cloud-datalabeling` library. See the [Quickstart](#quickstart) section to add `google-cloud-datalabeling` as a dependency in your code.
70+
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
71+
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
72+
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
7373

74-
Troubleshooting
75-
---------------
74+
### Installation and setup
7675

77-
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
76+
You'll need to obtain the `google-cloud-datalabeling` library. See the [Quickstart](#quickstart) section
77+
to add `google-cloud-datalabeling` as a dependency in your code.
7878

79-
Transport
80-
---------
81-
Cloud Data Labeling uses gRPC for the transport layer.
79+
## About Google Cloud Data Labeling
8280

83-
Java Versions
84-
-------------
81+
See the [Google Cloud Data Labeling client library docs][javadocs] to learn how to
82+
use this Google Cloud Data Labeling Client Library.
8583

86-
Java 7 or above is required for using this client.
84+
## Troubleshooting
8785

88-
Versioning
89-
----------
86+
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
9087

91-
This library follows [Semantic Versioning](http://semver.org/).
88+
## Transport
9289

93-
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.
90+
Google Cloud Data Labeling uses gRPC for the transport layer.
9491

95-
Contributing
96-
------------
92+
## Java Versions
9793

98-
Contributions to this library are always welcome and highly encouraged.
94+
Java 7 or above is required for using this client.
9995

100-
See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started.
96+
## Versioning
10197

102-
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 information.
98+
This library follows [Semantic Versioning](http://semver.org/).
99+
100+
101+
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
102+
and the public API should not be considered stable.
103103

104-
License
105-
-------
106104

107-
Apache 2.0 - See [LICENSE] for more information.
105+
## Contributing
108106

109107

110-
[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
111-
[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
112-
[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
113-
[cloud-platform]: https://cloud.google.com/
114-
[cloud-datalabeling]: http://cloud.google.com/data-labeling/docs/
115-
[datalabeling-product-docs]: http://cloud.google.com/data-labeling/docs/
116-
[datalabeling-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/datalabeling/v1beta1/package-summary.html
108+
Contributions to this library are always welcome and highly encouraged.
109+
110+
See [CONTRIBUTING][contributing] for more information how to get started.
111+
112+
Please note that this project is released with a Contributor Code of Conduct. By participating in
113+
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
114+
information.
115+
116+
## License
117+
118+
Apache 2.0 - See [LICENSE][license] for more information.
119+
120+
## CI Status
121+
122+
Java Version | Status
123+
------------ | ------
124+
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
125+
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
126+
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
127+
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
128+
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
129+
130+
[product-docs]: https://cloud.google.com/ai-platform/data-labeling/docs/
131+
[javadocs]: https://googleapis.dev/java/google-cloud-datalabeling/latest/index.html
132+
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java7.svg
133+
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java7.html
134+
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8.svg
135+
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8.html
136+
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8-osx.svg
137+
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8-osx.html
138+
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8-win.svg
139+
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8-win.html
140+
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java11.svg
141+
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java11.html
142+
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
143+
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-datalabeling.svg
144+
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-datalabeling&core=gav
145+
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
146+
[developer-console]: https://console.developers.google.com/
147+
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
148+
[cloud-sdk]: https://cloud.google.com/sdk/
149+
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
150+
[contributing]: https://github.com/googleapis/java-datalabeling/blob/master/CONTRIBUTING.md
151+
[code-of-conduct]: https://github.com/googleapis/java-datalabeling/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
152+
[license]: https://github.com/googleapis/java-datalabeling/blob/master/LICENSE
153+
154+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=datalabeling.googleapis.com
155+
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM

0 commit comments

Comments
 (0)