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