google-cloud-parameter_manager-v1 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/LICENSE.md +201 -0
- data/README.md +154 -0
- data/lib/google/cloud/parameter_manager/v1/bindings_override.rb +102 -0
- data/lib/google/cloud/parameter_manager/v1/parameter_manager/client.rb +1578 -0
- data/lib/google/cloud/parameter_manager/v1/parameter_manager/credentials.rb +47 -0
- data/lib/google/cloud/parameter_manager/v1/parameter_manager/paths.rb +90 -0
- data/lib/google/cloud/parameter_manager/v1/parameter_manager/rest/client.rb +1483 -0
- data/lib/google/cloud/parameter_manager/v1/parameter_manager/rest/service_stub.rb +756 -0
- data/lib/google/cloud/parameter_manager/v1/parameter_manager/rest.rb +53 -0
- data/lib/google/cloud/parameter_manager/v1/parameter_manager.rb +55 -0
- data/lib/google/cloud/parameter_manager/v1/rest.rb +38 -0
- data/lib/google/cloud/parameter_manager/v1/version.rb +28 -0
- data/lib/google/cloud/parameter_manager/v1.rb +45 -0
- data/lib/google/cloud/parametermanager/v1/service_pb.rb +73 -0
- data/lib/google/cloud/parametermanager/v1/service_services_pb.rb +65 -0
- data/lib/google-cloud-parameter_manager-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +473 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/field_info.rb +88 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/parametermanager/v1/service.rb +436 -0
- data/proto_docs/google/iam/v1/resource_policy_member.rb +49 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- metadata +147 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: e76bc4bacf1bf126f129adcef55219af47ed95524c50e54867119fe1000f8092
|
4
|
+
data.tar.gz: 9471b49f3d560524e8118b9d1a8eb4b745ccc8ce074c4bdf8b219eb102480b1f
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: a7dd0abf68b86696a1229f5e17fce1c228f10035c10d2267deb37b16de241d8d0995b8188e55aa042e6429b174c1c53a725c84129e6ffe4c5e42dd230e5cb9d1
|
7
|
+
data.tar.gz: 26a7fe2b3d36d979a54d3f4404a028499a0014e4bc644875fb1455faa0da10155d047229b0f6a051c7cc8c9100dc15f58b01e5c0339a6db8c4320dbec2243ee2
|
data/.yardopts
ADDED
data/AUTHENTICATION.md
ADDED
@@ -0,0 +1,122 @@
|
|
1
|
+
# Authentication
|
2
|
+
|
3
|
+
The recommended way to authenticate to the google-cloud-parameter_manager-v1 library is to use
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
6
|
+
|
7
|
+
## Quickstart
|
8
|
+
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
11
|
+
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
14
|
+
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
17
|
+
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
20
|
+
```
|
21
|
+
|
22
|
+
3. Write code as if already authenticated.
|
23
|
+
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
26
|
+
|
27
|
+
## Credential Lookup
|
28
|
+
|
29
|
+
The google-cloud-parameter_manager-v1 library provides several mechanisms to configure your system.
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
32
|
+
credentials, there are several methods available to you.
|
33
|
+
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
35
|
+
|
36
|
+
1. Credentials specified in method arguments
|
37
|
+
2. Credentials specified in configuration
|
38
|
+
3. Credentials pointed to or included in environment variables
|
39
|
+
4. Credentials found in local ADC file
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
41
|
+
|
42
|
+
### Configuration
|
43
|
+
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
49
|
+
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
52
|
+
whenever possible.
|
53
|
+
|
54
|
+
To configure a credentials file for an individual client initialization:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
require "google/cloud/parameter_manager/v1"
|
58
|
+
|
59
|
+
client = ::Google::Cloud::ParameterManager::V1::ParameterManager::Client.new do |config|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
To configure a credentials file globally for all clients:
|
65
|
+
|
66
|
+
```ruby
|
67
|
+
require "google/cloud/parameter_manager/v1"
|
68
|
+
|
69
|
+
::Google::Cloud::ParameterManager::V1::ParameterManager::Client.configure do |config|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
71
|
+
end
|
72
|
+
|
73
|
+
client = ::Google::Cloud::ParameterManager::V1::ParameterManager::Client.new
|
74
|
+
```
|
75
|
+
|
76
|
+
### Environment Variables
|
77
|
+
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
81
|
+
you can include the credentials file itself.
|
82
|
+
|
83
|
+
The JSON file can contain credentials created for
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
87
|
+
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
90
|
+
whenever possible.
|
91
|
+
|
92
|
+
The environment variables that google-cloud-parameter_manager-v1
|
93
|
+
checks for credentials are:
|
94
|
+
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/parameter_manager/v1"
|
100
|
+
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
102
|
+
|
103
|
+
client = ::Google::Cloud::ParameterManager::V1::ParameterManager::Client.new
|
104
|
+
```
|
105
|
+
|
106
|
+
### Local ADC file
|
107
|
+
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
110
|
+
then the local ADC credentials are discovered.
|
111
|
+
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
113
|
+
|
114
|
+
### Google Cloud Platform environments
|
115
|
+
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
120
|
+
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
data/LICENSE.md
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,154 @@
|
|
1
|
+
# Ruby Client for the Parameter Manager V1 API
|
2
|
+
|
3
|
+
(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.
|
4
|
+
|
5
|
+
(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.
|
6
|
+
|
7
|
+
https://github.com/googleapis/google-cloud-ruby
|
8
|
+
|
9
|
+
This gem is a _versioned_ client. It provides basic client classes for a
|
10
|
+
specific version of the Parameter Manager V1 API. Most users should consider using
|
11
|
+
the main client gem,
|
12
|
+
[google-cloud-parameter_manager](https://rubygems.org/gems/google-cloud-parameter_manager).
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
14
|
+
|
15
|
+
## Installation
|
16
|
+
|
17
|
+
```
|
18
|
+
$ gem install google-cloud-parameter_manager-v1
|
19
|
+
```
|
20
|
+
|
21
|
+
## Before You Begin
|
22
|
+
|
23
|
+
In order to use this library, you first need to go through the following steps:
|
24
|
+
|
25
|
+
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
26
|
+
1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
27
|
+
1. [Enable the API.](https://console.cloud.google.com/apis/library/parametermanager.googleapis.com)
|
28
|
+
1. {file:AUTHENTICATION.md Set up authentication.}
|
29
|
+
|
30
|
+
## Quick Start
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
require "google/cloud/parameter_manager/v1"
|
34
|
+
|
35
|
+
client = ::Google::Cloud::ParameterManager::V1::ParameterManager::Client.new
|
36
|
+
request = ::Google::Cloud::ParameterManager::V1::ListParametersRequest.new # (request fields as keyword arguments...)
|
37
|
+
response = client.list_parameters request
|
38
|
+
```
|
39
|
+
|
40
|
+
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-parameter_manager-v1/latest)
|
41
|
+
for class and method documentation.
|
42
|
+
|
43
|
+
See also the [Product Documentation](https://cloud.google.com/secret-manager/parameter-manager/docs/overview)
|
44
|
+
for general usage information.
|
45
|
+
|
46
|
+
## Debug Logging
|
47
|
+
|
48
|
+
This library comes with opt-in Debug Logging that can help you troubleshoot
|
49
|
+
your application's integration with the API. When logging is activated, key
|
50
|
+
events such as requests and responses, along with data payloads and metadata
|
51
|
+
such as headers and client configuration, are logged to the standard error
|
52
|
+
stream.
|
53
|
+
|
54
|
+
**WARNING:** Client Library Debug Logging includes your data payloads in
|
55
|
+
plaintext, which could include sensitive data such as PII for yourself or your
|
56
|
+
customers, private keys, or other security data that could be compromising if
|
57
|
+
leaked. Always practice good data hygiene with your application logs, and follow
|
58
|
+
the principle of least access. Google also recommends that Client Library Debug
|
59
|
+
Logging be enabled only temporarily during active debugging, and not used
|
60
|
+
permanently in production.
|
61
|
+
|
62
|
+
To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
|
63
|
+
to the value `all`. Alternatively, you can set the value to a comma-delimited
|
64
|
+
list of client library gem names. This will select the default logging behavior,
|
65
|
+
which writes logs to the standard error stream. On a local workstation, this may
|
66
|
+
result in logs appearing on the console. When running on a Google Cloud hosting
|
67
|
+
service such as [Google Cloud Run](https://cloud.google.com/run), this generally
|
68
|
+
results in logs appearing alongside your application logs in the
|
69
|
+
[Google Cloud Logging](https://cloud.google.com/logging/) service.
|
70
|
+
|
71
|
+
You can customize logging by modifying the `logger` configuration when
|
72
|
+
constructing a client object. For example:
|
73
|
+
|
74
|
+
```ruby
|
75
|
+
require "google/cloud/parameter_manager/v1"
|
76
|
+
require "logger"
|
77
|
+
|
78
|
+
client = ::Google::Cloud::ParameterManager::V1::ParameterManager::Client.new do |config|
|
79
|
+
config.logger = Logger.new "my-app.log"
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
## Google Cloud Samples
|
84
|
+
|
85
|
+
To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
|
86
|
+
|
87
|
+
## Supported Ruby Versions
|
88
|
+
|
89
|
+
This library is supported on Ruby 3.0+.
|
90
|
+
|
91
|
+
Google provides official support for Ruby versions that are actively supported
|
92
|
+
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
93
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
94
|
+
still work, but are unsupported and not recommended. See
|
95
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
96
|
+
support schedule.
|
97
|
+
|
98
|
+
## Which client should I use?
|
99
|
+
|
100
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
101
|
+
client library with a name such as `google-cloud-parameter_manager`,
|
102
|
+
and lower-level _versioned_ client libraries with names such as
|
103
|
+
`google-cloud-parameter_manager-v1`.
|
104
|
+
_In most cases, you should install the main client._
|
105
|
+
|
106
|
+
### What's the difference between the main client and a versioned client?
|
107
|
+
|
108
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
109
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
110
|
+
versions, there might be a separate versioned client for each service version.)
|
111
|
+
Most versioned clients are written and maintained by a code generator.
|
112
|
+
|
113
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
114
|
+
interfaces for the service. There will be only one main client for any given
|
115
|
+
service, even a service with multiple versions. The main client includes
|
116
|
+
factory methods for constructing the client objects we recommend for most
|
117
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
118
|
+
client; in other cases, they will be handwritten higher-level client objects
|
119
|
+
with additional capabilities, convenience methods, or best practices built in.
|
120
|
+
Generally, the main client will default to a recommended service version,
|
121
|
+
although in some cases you can override this if you need to talk to a specific
|
122
|
+
service version.
|
123
|
+
|
124
|
+
### Why would I want to use the main client?
|
125
|
+
|
126
|
+
We recommend that most users install the main client gem for a service. You can
|
127
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
128
|
+
`google-cloud-parameter_manager`.
|
129
|
+
The main client is recommended because it will embody the best practices for
|
130
|
+
accessing the service, and may also provide more convenient interfaces or
|
131
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
132
|
+
documentation and samples published by Google will generally demonstrate use of
|
133
|
+
the main client.
|
134
|
+
|
135
|
+
### Why would I want to use a versioned client?
|
136
|
+
|
137
|
+
You can use a versioned client if you are content with a possibly lower-level
|
138
|
+
class interface, you explicitly want to avoid features provided by the main
|
139
|
+
client, or you want to access a specific service version not be covered by the
|
140
|
+
main client. You can identify versioned client gems because the service version
|
141
|
+
is part of the name, e.g. `google-cloud-parameter_manager-v1`.
|
142
|
+
|
143
|
+
### What about the google-apis-<name> clients?
|
144
|
+
|
145
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
146
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
147
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
148
|
+
not offer the same performance, features, and ease of use provided by more
|
149
|
+
modern clients.
|
150
|
+
|
151
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
152
|
+
might need to use one if there is no modern client available for the service.
|
153
|
+
However, if a modern client is available, we generally recommend it over the
|
154
|
+
older `google-apis-` clients.
|
@@ -0,0 +1,102 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "gapic/config"
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Cloud
|
23
|
+
module ParameterManager
|
24
|
+
##
|
25
|
+
# @example Loading just the REST part of this package, including all its services, and instantiating a REST client
|
26
|
+
#
|
27
|
+
# require "google/cloud/parameter_manager/v1/rest"
|
28
|
+
# client = ::Google::Cloud::ParameterManager::V1::ParameterManager::Rest::Client.new
|
29
|
+
#
|
30
|
+
module V1
|
31
|
+
##
|
32
|
+
# @private
|
33
|
+
# Initialize the mixin bindings configuration
|
34
|
+
#
|
35
|
+
def self.configure
|
36
|
+
@configure ||= begin
|
37
|
+
namespace = ["Google", "Cloud", "ParameterManager"]
|
38
|
+
parent_config = while namespace.any?
|
39
|
+
parent_name = namespace.join "::"
|
40
|
+
parent_const = const_get parent_name
|
41
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
42
|
+
namespace.pop
|
43
|
+
end
|
44
|
+
|
45
|
+
default_config = Configuration.new parent_config
|
46
|
+
default_config.bindings_override["google.cloud.location.Locations.GetLocation"] = [
|
47
|
+
Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
|
48
|
+
uri_method: :get,
|
49
|
+
uri_template: "/v1/{name}",
|
50
|
+
matches: [
|
51
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
|
52
|
+
],
|
53
|
+
body: nil
|
54
|
+
)
|
55
|
+
]
|
56
|
+
default_config.bindings_override["google.cloud.location.Locations.ListLocations"] = [
|
57
|
+
|
58
|
+
Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
|
59
|
+
uri_method: :get,
|
60
|
+
uri_template: "/v1/{name}/locations",
|
61
|
+
matches: [
|
62
|
+
["name", %r{^projects/[^/]+/?$}, false]
|
63
|
+
],
|
64
|
+
body: nil
|
65
|
+
)
|
66
|
+
]
|
67
|
+
default_config
|
68
|
+
end
|
69
|
+
yield @configure if block_given?
|
70
|
+
@configure
|
71
|
+
end
|
72
|
+
|
73
|
+
##
|
74
|
+
# @private
|
75
|
+
# Configuration class for the google.cloud.parametermanager.v1 package.
|
76
|
+
#
|
77
|
+
# This class contains common configuration for all services
|
78
|
+
# of the google.cloud.parametermanager.v1 package.
|
79
|
+
#
|
80
|
+
# This configuration is for internal use of the client library classes,
|
81
|
+
# and it is not intended that the end-users will read or change it.
|
82
|
+
#
|
83
|
+
class Configuration
|
84
|
+
extend ::Gapic::Config
|
85
|
+
|
86
|
+
# @private
|
87
|
+
# Overrides for http bindings for the RPC of the mixins for this package.
|
88
|
+
# Services in this package should use these when creating clients for the mixin services.
|
89
|
+
# @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
|
90
|
+
config_attr :bindings_override, {}, ::Hash, nil
|
91
|
+
|
92
|
+
# @private
|
93
|
+
def initialize parent_config = nil
|
94
|
+
@parent_config = parent_config unless parent_config.nil?
|
95
|
+
|
96
|
+
yield self if block_given?
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|