Skip to content

Commit c84532c

Browse files
authored
feat: [advisorynotifications] new module for advisorynotifications (#9141)
* feat: [advisorynotifications] new module for advisorynotifications * chore: remove .python-version file
1 parent 5783126 commit c84532c

File tree

66 files changed

+19392
-0
lines changed

Some content is hidden

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

66 files changed

+19392
-0
lines changed

gapic-libraries-bom/pom.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@
3535
<type>pom</type>
3636
<scope>import</scope>
3737
</dependency>
38+
<dependency>
39+
<groupId>com.google.cloud</groupId>
40+
<artifactId>google-cloud-advisorynotifications-bom</artifactId>
41+
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:google-cloud-advisorynotifications:current} -->
42+
<type>pom</type>
43+
<scope>import</scope>
44+
</dependency>
3845
<dependency>
3946
<groupId>com.google.cloud</groupId>
4047
<artifactId>google-cloud-aiplatform-bom</artifactId>
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
16+
deep-remove-regex:
17+
- "/java-advisorynotifications/grpc-google-.*/src"
18+
- "/java-advisorynotifications/proto-google-.*/src"
19+
- "/java-advisorynotifications/google-.*/src"
20+
- "/java-advisorynotifications/samples/snippets/generated"
21+
22+
deep-preserve-regex:
23+
- "/java-advisorynotifications/google-.*/src/test/java/com/google/cloud/.*/v.*/it/IT.*Test.java"
24+
25+
deep-copy-regex:
26+
- source: "/google/cloud/advisorynotifications/(v.*)/.*-java/proto-google-.*/src"
27+
dest: "/owl-bot-staging/java-advisorynotifications/$1/proto-google-cloud-advisorynotifications-$1/src"
28+
- source: "/google/cloud/advisorynotifications/(v.*)/.*-java/grpc-google-.*/src"
29+
dest: "/owl-bot-staging/java-advisorynotifications/$1/grpc-google-cloud-advisorynotifications-$1/src"
30+
- source: "/google/cloud/advisorynotifications/(v.*)/.*-java/gapic-google-.*/src"
31+
dest: "/owl-bot-staging/java-advisorynotifications/$1/google-cloud-advisorynotifications/src"
32+
- source: "/google/cloud/advisorynotifications/(v.*)/.*-java/samples/snippets/generated"
33+
dest: "/owl-bot-staging/java-advisorynotifications/$1/samples/snippets/generated"
34+
35+
36+
api-name: advisorynotifications
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"api_shortname": "advisorynotifications",
3+
"name_pretty": "Advisory Notifications API",
4+
"product_documentation": "https://cloud.google.com/advisory-notifications/",
5+
"api_description": "An API for accessing Advisory Notifications in Google Cloud.",
6+
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-advisorynotifications/latest/overview",
7+
"release_level": "preview",
8+
"transport": "grpc",
9+
"language": "java",
10+
"repo": "googleapis/java-advisorynotifications",
11+
"repo_short": "java-advisorynotifications",
12+
"distribution_name": "com.google.cloud:google-cloud-advisorynotifications",
13+
"api_id": "advisorynotifications.googleapis.com",
14+
"library_type": "GAPIC_AUTO",
15+
"requires_billing": true
16+
}

java-advisorynotifications/README.md

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

0 commit comments

Comments
 (0)