You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
See the [Authentication][authentication] section in the base directory's README.
41
+
42
+
## Authorization
43
+
44
+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Common Protos APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Common Protos API calls.
45
+
46
+
## Getting Started
47
+
48
+
### Prerequisites
49
+
50
+
You will need a [Google Cloud Platform Console][developer-console] project with the Common Protos [API enabled][enable-api].
51
+
You will need to [enable billing][enable-billing] to use Google Common Protos.
52
+
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
53
+
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
54
+
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
55
+
56
+
### Installation and setup
57
+
58
+
You'll need to obtain the `proto-google-common-protos` library. See the [Quickstart](#quickstart) section
59
+
to add `proto-google-common-protos` as a dependency in your code.
60
+
61
+
## About Common Protos
62
+
63
+
64
+
[Common Protos][product-docs] Protobuf classes for Google's common protos.
65
+
66
+
See the [Common Protos client library docs][javadocs] to learn how to
67
+
use this Common Protos Client Library.
68
+
69
+
70
+
71
+
72
+
73
+
74
+
## Troubleshooting
75
+
76
+
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
77
+
78
+
## Transport
79
+
80
+
Common Protos uses gRPC for the transport layer.
81
+
82
+
## Supported Java Versions
83
+
84
+
Java 8 or above is required for using this client.
85
+
86
+
Google's Java client libraries,
87
+
[Google Cloud Client Libraries][cloudlibs]
88
+
and
89
+
[Google Cloud API Libraries][apilibs],
90
+
follow the
91
+
[Oracle Java SE support roadmap][oracle]
92
+
(see the Oracle Java SE Product Releases section).
93
+
94
+
### For new development
95
+
96
+
In general, new feature development occurs with support for the lowest Java
97
+
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
98
+
from initial General Availability). If the minimum required JVM for a given
99
+
library is changed, it is accompanied by a [semver][semver] major release.
100
+
101
+
Java 11 and (in September 2021) Java 17 are the best choices for new
102
+
development.
103
+
104
+
### Keeping production systems current
105
+
106
+
Google tests its client libraries with all current LTS versions covered by
107
+
Oracle's Extended Support (which typically lasts 8 years from initial
108
+
General Availability).
109
+
110
+
#### Legacy support
111
+
112
+
Google's client libraries support legacy versions of Java runtimes with long
113
+
term stable libraries that don't receive feature updates on a best efforts basis
114
+
as it may not be possible to backport all patches.
115
+
116
+
Google provides updates on a best efforts basis to apps that continue to use
117
+
Java 7, though apps might need to upgrade to current versions of the library
118
+
that supports their JVM.
119
+
120
+
#### Where to find specific information
121
+
122
+
The latest versions and the supported Java versions are identified on
123
+
the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME`
124
+
and on [google-cloud-java][g-c-j].
13
125
14
126
## Versioning
15
127
128
+
16
129
This library follows [Semantic Versioning](http://semver.org/).
17
130
131
+
132
+
18
133
## Contributing
19
134
135
+
20
136
Contributions to this library are always welcome and highly encouraged.
21
137
22
138
See [CONTRIBUTING][contributing] for more information how to get started.
@@ -25,41 +141,55 @@ Please note that this project is released with a Contributor Code of Conduct. By
25
141
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
26
142
information.
27
143
144
+
28
145
## License
29
146
30
147
Apache 2.0 - See [LICENSE][license] for more information.
0 commit comments