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

Commit 063e1d1

Browse files
authored
chore: update repo-metadata and regenerate README from templates (#63)
1 parent cbb810a commit 063e1d1

File tree

4 files changed

+89
-72
lines changed

4 files changed

+89
-72
lines changed

.repo-metadata.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22
"name": "cloudtasks",
33
"name_pretty": "Cloud Tasks",
44
"product_documentation": "https://cloud.google.com/tasks/docs/",
5-
"client_documentation": "https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/tasks/v2/package-summary.html",
5+
"client_documentation": "https://googleapis.dev/java/google-cloud-tasks/latest/",
66
"issue_tracker": "https://issuetracker.google.com/savedsearches/5433985",
77
"release_level": "ga",
88
"language": "java",
99
"repo": "googleapis/java-tasks",
1010
"repo_short": "java-tasks",
1111
"distribution_name": "com.google.cloud:google-cloud-tasks",
12-
"api_id": "cloudtasks.googleapis.com"
12+
"api_id": "cloudtasks.googleapis.com",
13+
"transport": "grpc",
14+
"requires_billing": true,
15+
"api_description": "a fully managed service that allows you to manage the execution, dispatch and delivery of a large number of distributed tasks. You can asynchronously perform work outside of a user request. Your tasks can be executed on App Engine or any arbitrary HTTP endpoint."
1316
}

README.md

Lines changed: 79 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,49 @@
1-
Google Cloud Java Client for Cloud Tasks
2-
======================================
1+
# Google Cloud Tasks Client for Java
32

4-
Java idiomatic client for [Cloud Tasks][cloud-tasks].
3+
Java idiomatic client for [Cloud Tasks][product-docs].
54

6-
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-tasks.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-tasks.svg)
5+
[![Maven][maven-version-image]][maven-version-link]
76
![Stability][stability-image]
87

9-
- [Product Documentation][tasks]
10-
- [Client Library Documentation][tasks-client-lib-docs]
8+
- [Product Documentation][product-docs]
9+
- [Client Library Documentation][javadocs]
1110

12-
> Note: This client is a work-in-progress, and may occasionally
13-
> make backwards-incompatible changes.
11+
## Quickstart
1412

15-
Quickstart
16-
----------
17-
If you are using Maven with Bom, Add this to your pom.xml file.
13+
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
1814
```xml
1915
<dependencyManagement>
20-
<dependencies>
21-
<dependency>
22-
<groupId>com.google.cloud</groupId>
23-
<artifactId>libraries-bom</artifactId>
24-
<version>3.5.0</version>
25-
<type>pom</type>
26-
<scope>import</scope>
27-
</dependency>
28-
</dependencies>
16+
<dependencies>
17+
<dependency>
18+
<groupId>com.google.cloud</groupId>
19+
<artifactId>libraries-bom</artifactId>
20+
<version>3.5.0</version>
21+
<type>pom</type>
22+
<scope>import</scope>
23+
</dependency>
24+
</dependencies>
2925
</dependencyManagement>
3026

31-
<dependency>
32-
<groupId>com.google.cloud</groupId>
33-
<artifactId>google-cloud-tasks</artifactId>
34-
</dependency>
27+
<dependencies>
28+
<dependency>
29+
<groupId>com.google.cloud</groupId>
30+
<artifactId>google-cloud-tasks</artifactId>
31+
</dependency>
32+
</dependencies>
3533
```
34+
3635
[//]: # ({x-version-update-start:google-cloud-tasks:released})
37-
If you are using Maven without Bom, Add this to your dependencies.
36+
37+
If you are using Maven without BOM, add this to your dependencies:
38+
3839
```xml
3940
<dependency>
4041
<groupId>com.google.cloud</groupId>
4142
<artifactId>google-cloud-tasks</artifactId>
4243
<version>1.28.0</version>
4344
</dependency>
4445
```
46+
4547
If you are using Gradle, add this to your dependencies
4648
```Groovy
4749
compile 'com.google.cloud:google-cloud-tasks:1.28.0'
@@ -52,60 +54,68 @@ libraryDependencies += "com.google.cloud" % "google-cloud-tasks" % "1.28.0"
5254
```
5355
[//]: # ({x-version-update-end})
5456

55-
Authentication
56-
--------------
57+
## Authentication
58+
59+
See the [Authentication][authentication] section in the base directory's README.
60+
61+
## Getting Started
62+
63+
### Prerequisites
64+
65+
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Tasks [API enabled][enable-api].
66+
You will need to [enable billing][enable-billing] to use Google Cloud Tasks.
67+
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
68+
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
69+
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
70+
71+
### Installation and setup
5772

58-
See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
73+
You'll need to obtain the `google-cloud-tasks` library. See the [Quickstart](#quickstart) section
74+
to add `google-cloud-tasks` as a dependency in your code.
5975

60-
About Google Cloud Cloud Tasks
61-
----------------------------
76+
## About Cloud Tasks
6277

63-
Google [Cloud Tasks API][cloud-tasks] manages Cloud Tasks queues and tasks.
6478

65-
See the [Cloud Tasks client library docs][tasks-client-lib-docs] to learn how to use this Cloud Tasks API Client Library.
79+
[Cloud Tasks][product-docs] a fully managed service that allows you to manage the execution, dispatch and delivery of a large number of distributed tasks. You can asynchronously perform work outside of a user request. Your tasks can be executed on App Engine or any arbitrary HTTP endpoint.
6680

67-
Getting Started
68-
---------------
69-
#### Prerequisites
70-
You will need a [Google Developers Console](https://console.developers.google.com/) project with the Cloud Tasks 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]`.
81+
See the [Cloud Tasks client library docs][javadocs] to learn how to
82+
use this Cloud Tasks Client Library.
7183

72-
#### Installation and setup
73-
You'll need to obtain the `google-cloud-tasks` library. See the [Quickstart](#quickstart) section to add `google-cloud-tasks` as a dependency in your code.
7484

75-
Troubleshooting
76-
---------------
7785

78-
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
7986

80-
Transport
81-
---------
87+
## Troubleshooting
88+
89+
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
90+
91+
## Transport
92+
8293
Cloud Tasks uses gRPC for the transport layer.
8394

84-
Java Versions
85-
-------------
95+
## Java Versions
8696

8797
Java 7 or above is required for using this client.
8898

89-
Versioning
90-
----------
99+
## Versioning
91100

92101
This library follows [Semantic Versioning](http://semver.org/).
93102

94-
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.
95103

96-
Contributing
97-
------------
104+
105+
## Contributing
106+
98107

99108
Contributions to this library are always welcome and highly encouraged.
100109

101-
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.
110+
See [CONTRIBUTING][contributing] for more information how to get started.
102111

103-
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.
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.
104115

105-
License
106-
-------
116+
## License
107117

108-
Apache 2.0 - See [LICENSE] for more information.
118+
Apache 2.0 - See [LICENSE][license] for more information.
109119

110120
## CI Status
111121

@@ -117,6 +127,8 @@ Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
117127
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
118128
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
119129

130+
[product-docs]: https://cloud.google.com/tasks/docs/
131+
[javadocs]: https://googleapis.dev/java/google-cloud-tasks/latest/
120132
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tasks/java7.svg
121133
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tasks/java7.html
122134
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tasks/java8.svg
@@ -128,10 +140,16 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
128140
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tasks/java11.svg
129141
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tasks/java11.html
130142
[stability-image]: https://img.shields.io/badge/stability-ga-green
131-
[CONTRIBUTING]: https://github.com/googleapis/java-tasks/blob/master/CONTRIBUTING.md
143+
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-tasks.svg
144+
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-tasks&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-tasks/blob/master/CONTRIBUTING.md
132151
[code-of-conduct]: https://github.com/googleapis/java-tasks/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
133-
[LICENSE]: https://github.com/googleapis/java-tasks/blob/master/LICENSE
134-
[cloud-platform]: https://cloud.google.com/
135-
[cloud-tasks]: https://cloud.google.com/tasks
136-
[tasks]: https://cloud.google.com/tasks/docs
137-
[tasks-client-lib-docs]: https://googleapis.dev/java/google-cloud-tasks/latest/index.html
152+
[license]: https://github.com/googleapis/java-tasks/blob/master/LICENSE
153+
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
154+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=cloudtasks.googleapis.com
155+
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM

synth.metadata

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"updateTime": "2020-02-01T09:04:42.731426Z",
2+
"updateTime": "2020-02-03T23:35:32.050428Z",
33
"sources": [
44
{
55
"generator": {
@@ -12,9 +12,9 @@
1212
"git": {
1313
"name": "googleapis",
1414
"remote": "https://github.com/googleapis/googleapis.git",
15-
"sha": "b5cbe4a4ba64ab19e6627573ff52057a1657773d",
16-
"internalRef": "292647187",
17-
"log": "b5cbe4a4ba64ab19e6627573ff52057a1657773d\nSecurityCenter v1p1beta1: move file-level option on top to workaround protobuf.js bug.\n\nPiperOrigin-RevId: 292647187\n\nb224b317bf20c6a4fbc5030b4a969c3147f27ad3\nAdds API definitions for bigqueryreservation v1beta1.\n\nPiperOrigin-RevId: 292634722\n\nc1468702f9b17e20dd59007c0804a089b83197d2\nSynchronize new proto/yaml changes.\n\nPiperOrigin-RevId: 292626173\n\nffdfa4f55ab2f0afc11d0eb68f125ccbd5e404bd\nvision: v1p3beta1 publish annotations and retry config\n\nPiperOrigin-RevId: 292605599\n\n78f61482cd028fc1d9892aa5d89d768666a954cd\nvision: v1p1beta1 publish annotations and retry config\n\nPiperOrigin-RevId: 292605125\n\n60bb5a294a604fd1778c7ec87b265d13a7106171\nvision: v1p2beta1 publish annotations and retry config\n\nPiperOrigin-RevId: 292604980\n\n3bcf7aa79d45eb9ec29ab9036e9359ea325a7fc3\nvision: v1p4beta1 publish annotations and retry config\n\nPiperOrigin-RevId: 292604656\n\n2717b8a1c762b26911b45ecc2e4ee01d98401b28\nFix dataproc artman client library generation.\n\nPiperOrigin-RevId: 292555664\n\n"
15+
"sha": "29d40b78e3dc1579b0b209463fbcb76e5767f72a",
16+
"internalRef": "292979741",
17+
"log": "29d40b78e3dc1579b0b209463fbcb76e5767f72a\nExpose managedidentities/v1beta1/ API for client library usage.\n\nPiperOrigin-RevId: 292979741\n\na22129a1fb6e18056d576dfb7717aef74b63734a\nExpose managedidentities/v1/ API for client library usage.\n\nPiperOrigin-RevId: 292968186\n\n"
1818
}
1919
},
2020
{

synth.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,4 @@
8181
java.format_code(f'grpc-google-cloud-{service}-{version}/src')
8282
java.format_code(f'proto-google-cloud-{service}-{version}/src')
8383

84-
common_templates = gcp.CommonTemplates()
85-
templates = common_templates.java_library()
86-
s.copy(templates, excludes=[
87-
'README.md',
88-
])
84+
java.common_templates()

0 commit comments

Comments
 (0)