Skip to content

Commit 9ffe581

Browse files
suztomosuztomo
committed
feat(google/cloud/sql/v1): onboard a new library
1 parent 5e54547 commit 9ffe581

812 files changed

Lines changed: 445253 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎gapic-libraries-bom/pom.xml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1353,6 +1353,13 @@
13531353
<type>pom</type>
13541354
<scope>import</scope>
13551355
</dependency>
1356+
<dependency>
1357+
<groupId>com.google.cloud</groupId>
1358+
<artifactId>google-cloud-sql-bom</artifactId>
1359+
<version>0.1.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-sql:current} -->
1360+
<type>pom</type>
1361+
<scope>import</scope>
1362+
</dependency>
13561363
<dependency>
13571364
<groupId>com.google.cloud</groupId>
13581365
<artifactId>google-cloud-storage-bom</artifactId>

‎java-sql/.repo-metadata.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"api_shortname": "sqladmin",
3+
"name_pretty": "Cloud SQL Admin",
4+
"product_documentation": "",
5+
"api_description": "Cloud SQL Admin API",
6+
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-sql/latest/overview",
7+
"release_level": "preview",
8+
"transport": "grpc+rest",
9+
"language": "java",
10+
"repo": "googleapis/google-cloud-java",
11+
"repo_short": "java-sql",
12+
"distribution_name": "com.google.cloud:google-cloud-sql",
13+
"api_id": "sqladmin.googleapis.com",
14+
"library_type": "GAPIC_AUTO"
15+
}

‎java-sql/README.md‎

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
# Google Cloud SQL Admin Client for Java
2+
3+
Java idiomatic client for [Cloud SQL Admin][product-docs].
4+
5+
[![Maven][maven-version-image]][maven-version-link]
6+
![Stability][stability-image]
7+
8+
- [Product Documentation][product-docs]
9+
- [Client Library Documentation][javadocs]
10+
11+
> Note: This client is a work-in-progress, and may occasionally
12+
> make backwards-incompatible changes.
13+
14+
15+
## Quickstart
16+
17+
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
18+
19+
```xml
20+
<dependencyManagement>
21+
<dependencies>
22+
<dependency>
23+
<groupId>com.google.cloud</groupId>
24+
<artifactId>libraries-bom</artifactId>
25+
<version>26.83.0</version>
26+
<type>pom</type>
27+
<scope>import</scope>
28+
</dependency>
29+
</dependencies>
30+
</dependencyManagement>
31+
32+
<dependencies>
33+
<dependency>
34+
<groupId>com.google.cloud</groupId>
35+
<artifactId>google-cloud-sql</artifactId>
36+
</dependency>
37+
</dependencies>
38+
```
39+
40+
If you are using Maven without the BOM, add this to your dependencies:
41+
42+
43+
```xml
44+
<dependency>
45+
<groupId>com.google.cloud</groupId>
46+
<artifactId>google-cloud-sql</artifactId>
47+
<version>0.0.0</version>
48+
</dependency>
49+
```
50+
51+
If you are using Gradle 5.x or later, add this to your dependencies:
52+
53+
```Groovy
54+
implementation platform('com.google.cloud:libraries-bom:26.83.0')
55+
56+
implementation 'com.google.cloud:google-cloud-sql'
57+
```
58+
59+
If you are using Gradle without BOM, add this to your dependencies:
60+
61+
```Groovy
62+
implementation 'com.google.cloud:google-cloud-sql:0.0.0'
63+
```
64+
65+
If you are using SBT, add this to your dependencies:
66+
67+
```Scala
68+
libraryDependencies += "com.google.cloud" % "google-cloud-sql" % "0.0.0"
69+
```
70+
71+
## Authentication
72+
73+
See the [Authentication][authentication] section in the base directory's README.
74+
75+
## Authorization
76+
77+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Cloud SQL Admin APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Cloud SQL Admin API calls.
78+
79+
## Getting Started
80+
81+
### Prerequisites
82+
83+
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud SQL Admin [API enabled][enable-api].
84+
You will need to [enable billing][enable-billing] to use Google Cloud SQL Admin.
85+
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
86+
[installing the Google Cloud Command Line Interface][cloud-cli] and running the following commands in command line:
87+
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
88+
89+
### Installation and setup
90+
91+
You'll need to obtain the `google-cloud-sql` library. See the [Quickstart](#quickstart) section
92+
to add `google-cloud-sql` as a dependency in your code.
93+
94+
## About Cloud SQL Admin
95+
96+
97+
[Cloud SQL Admin][product-docs] Cloud SQL Admin API
98+
99+
See the [Cloud SQL Admin client library docs][javadocs] to learn how to
100+
use this Cloud SQL Admin Client Library.
101+
102+
103+
104+
105+
106+
107+
## Troubleshooting
108+
109+
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
110+
111+
## Transport
112+
113+
Cloud SQL Admin uses both gRPC and HTTP/JSON for the transport layer.
114+
115+
## Supported Java Versions
116+
117+
Java 8 or above is required for using this client.
118+
119+
Google's Java client libraries,
120+
[Google Cloud Client Libraries][cloudlibs]
121+
and
122+
[Google Cloud API Libraries][apilibs],
123+
follow the
124+
[Oracle Java SE support roadmap][oracle]
125+
(see the Oracle Java SE Product Releases section).
126+
127+
### For new development
128+
129+
In general, new feature development occurs with support for the lowest Java
130+
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
131+
from initial General Availability). If the minimum required JVM for a given
132+
library is changed, it is accompanied by a [semver][semver] major release.
133+
134+
Java 11 and (in September 2021) Java 17 are the best choices for new
135+
development.
136+
137+
### Keeping production systems current
138+
139+
Google tests its client libraries with all current LTS versions covered by
140+
Oracle's Extended Support (which typically lasts 8 years from initial
141+
General Availability).
142+
143+
#### Legacy support
144+
145+
Google's client libraries support legacy versions of Java runtimes with long
146+
term stable libraries that don't receive feature updates on a best efforts basis
147+
as it may not be possible to backport all patches.
148+
149+
Google provides updates on a best efforts basis to apps that continue to use
150+
Java 7, though apps might need to upgrade to current versions of the library
151+
that supports their JVM.
152+
153+
#### Where to find specific information
154+
155+
The latest versions and the supported Java versions are identified on
156+
the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME`
157+
and on [google-cloud-java][g-c-j].
158+
159+
## Versioning
160+
This library follows [Semantic Versioning](http://semver.org/).
161+
162+
163+
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
164+
and the public API should not be considered stable.
165+
166+
167+
## Contributing
168+
169+
170+
Contributions to this library are always welcome and highly encouraged.
171+
172+
See [CONTRIBUTING][contributing] for more information how to get started.
173+
174+
Please note that this project is released with a Contributor Code of Conduct. By participating in
175+
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
176+
information.
177+
178+
179+
## License
180+
181+
Apache 2.0 - See [LICENSE][license] for more information.
182+
183+
Java is a registered trademark of Oracle and/or its affiliates.
184+
185+
[product-docs]:
186+
[javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-sql/latest/overview
187+
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
188+
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-sql.svg
189+
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-sql/0.0.0
190+
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
191+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
192+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
193+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
194+
[developer-console]: https://console.developers.google.com/
195+
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
196+
[cloud-cli]: https://cloud.google.com/cli
197+
[troubleshooting]: https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md
198+
[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md
199+
[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
200+
[license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE
201+
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
202+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=sqladmin.googleapis.com
203+
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
204+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
205+
206+
[semver]: https://semver.org/
207+
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
208+
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
209+
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
210+
[g-c-j]: http://github.com/googleapis/google-cloud-java

‎java-sql/google-cloud-sql-bom/pom.xml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3+
<modelVersion>4.0.0</modelVersion>
4+
<groupId>com.google.cloud</groupId>
5+
<artifactId>google-cloud-sql-bom</artifactId>
6+
<version>0.1.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-sql:current} -->
7+
<packaging>pom</packaging>
8+
<parent>
9+
<groupId>com.google.cloud</groupId>
10+
<artifactId>google-cloud-pom-parent</artifactId>
11+
<version>1.89.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-pom-parent:current} -->
12+
<relativePath>../../google-cloud-pom-parent/pom.xml</relativePath>
13+
</parent>
14+
15+
<name>Google Cloud SQL Admin BOM</name>
16+
<description>
17+
BOM for Cloud SQL Admin
18+
</description>
19+
20+
<properties>
21+
<maven.antrun.skip>true</maven.antrun.skip>
22+
</properties>
23+
24+
<dependencyManagement>
25+
<dependencies>
26+
<!-- {x-generated-dependencies-start} -->
27+
<dependency>
28+
<groupId>com.google.cloud</groupId>
29+
<artifactId>google-cloud-sql</artifactId>
30+
<version>0.1.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-sql:current} -->
31+
</dependency>
32+
<dependency>
33+
<groupId>com.google.api.grpc</groupId>
34+
<artifactId>grpc-google-cloud-sql-v1</artifactId>
35+
<version>0.1.0-SNAPSHOT</version><!-- {x-version-update:grpc-google-cloud-sql-v1:current} -->
36+
</dependency>
37+
<dependency>
38+
<groupId>com.google.api.grpc</groupId>
39+
<artifactId>proto-google-cloud-sql-v1</artifactId>
40+
<version>0.1.0-SNAPSHOT</version><!-- {x-version-update:proto-google-cloud-sql-v1:current} -->
41+
</dependency>
42+
<!-- {x-generated-dependencies-end} -->
43+
</dependencies>
44+
</dependencyManagement>
45+
</project>

0 commit comments

Comments
 (0)