-
Notifications
You must be signed in to change notification settings - Fork 445
Expand file tree
/
Copy pathmain.dox
More file actions
47 lines (33 loc) · 1.92 KB
/
main.dox
File metadata and controls
47 lines (33 loc) · 1.92 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/*!
@mainpage Parameter Manager API C++ Client Library
An idiomatic C++ client library for the [Parameter Manager API][cloud-service-docs].
(Public Preview) Parameter Manager is a single source of truth to store, access and manage the lifecycle of your workload parameters. Parameter Manager aims to make management of sensitive application parameters effortless for customers without diminishing focus on security.
While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow
[Semantic Versioning](https://semver.org/).
@tableofcontents{HTML:2}
## Quickstart
The following shows the code that you'll run in the
`google/cloud/parametermanager/quickstart/` directory,
which should give you a taste of the Parameter Manager API C++ client library API.
@snippet quickstart.cc all
## Main classes
<!-- inject-client-list-start -->
The main class in this library is
[`parametermanager_v1::ParameterManagerClient`](@ref google::cloud::parametermanager_v1::ParameterManagerClient). All RPCs are exposed
as member functions of this class. Other classes provide helpers, configuration
parameters, and infrastructure to mock
[`parametermanager_v1::ParameterManagerClient`](@ref google::cloud::parametermanager_v1::ParameterManagerClient) when testing your
application.
<!-- inject-client-list-end -->
## More Information
- @ref common-error-handling - describes how the library reports errors.
- @ref parametermanager-override-endpoint - describes how to override the default
endpoint.
- @ref parametermanager-override-authentication - describes how to change the
authentication credentials used by the library.
- @ref parametermanager-override-retry - describes how to change the default retry
policies.
- @ref parametermanager-env - describes environment variables that can configure the
behavior of the library.
[cloud-service-docs]: https://cloud.google.com/secret-manager/parameter-manager/docs/overview
*/