google-cloud-secret_manager-v1beta1 0.12.2 → 0.14.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 200d3d591406c4a78326361b42dd4fe09adb15da0fbfb442ccfa3dec8ba33c81
4
- data.tar.gz: b2a7a922a9443f823852f0dcdeee79258a89720e643b5b47e3cd5549a27edd1c
3
+ metadata.gz: 8fda778bf80b4e2f0fe79809bf04052f44eb4dc2669b3a2940b3e1b714403308
4
+ data.tar.gz: 552be8b2a9ec18a657bd8176e8901f4d2ae94acdcef2fbb317c50b7f53e194d1
5
5
  SHA512:
6
- metadata.gz: '079b376c6215b66b6f25ee2e8730e3f430ed0d397641f7c92f427451b405df54845cf523986b8903f57021f6d5392af847d1e2a06b2b18ff50beff8fbf81c209'
7
- data.tar.gz: 9a3fc51942b562d8d266f7ee0a96fb14ee514cd7cdeb132be8131eb5d563b71d8087ff2d70df354104df1bec905fcd69ce0d1cd44b71679b8357ffb4677cdb3a
6
+ metadata.gz: ee5beb8cbc7bcec1ce509aad6696174d8204a8be856787456d092adb75834428b5e63cb0a2d6105da817bbcea7b53634f75597a027f6108b996e2dc53a135420
7
+ data.tar.gz: d3f841882f41be02b1eb77f1eb4558256208f0fc88a205b61815908c67ccb86fd317dbced4f511508b64b5001e12cef3234c23e128d120ea7b3342f5f750c0d6
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-secret_manager-v1beta1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-secret_manager-v1beta1 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).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export SECRET_MANAGER_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/secret_manager/v1beta1"
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:
29
17
 
30
- client = ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-secret_manager-v1beta1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
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).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-secret_manager-v1beta1 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.
64
33
 
65
- The environment variables that google-cloud-secret_manager-v1beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `SECRET_MANAGER_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `SECRET_MANAGER_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
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)
74
41
 
75
- ```ruby
76
- require "google/cloud/secret_manager/v1beta1"
77
-
78
- ENV["SECRET_MANAGER_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.new
81
- ```
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).
82
49
 
83
- ### Configuration
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.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
86
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/secret_manager/v1beta1"
90
58
 
91
59
  client = ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/secret_manager/v1beta1"
100
68
 
101
69
  ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
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.
113
82
 
114
- To configure your system for this, simply:
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).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
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-secret_manager-v1beta1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/secret_manager/v1beta1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-secret_manager-v1beta1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
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.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
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.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
@@ -36,6 +36,9 @@ module Google
36
36
  # * {::Google::Cloud::SecretManager::V1beta1::SecretVersion SecretVersion}
37
37
  #
38
38
  class Client
39
+ # @private
40
+ DEFAULT_ENDPOINT_TEMPLATE = "secretmanager.$UNIVERSE_DOMAIN$"
41
+
39
42
  include Paths
40
43
 
41
44
  # @private
@@ -129,6 +132,15 @@ module Google
129
132
  @config
130
133
  end
131
134
 
135
+ ##
136
+ # The effective universe domain
137
+ #
138
+ # @return [String]
139
+ #
140
+ def universe_domain
141
+ @secret_manager_service_stub.universe_domain
142
+ end
143
+
132
144
  ##
133
145
  # Create a new SecretManagerService client object.
134
146
  #
@@ -162,8 +174,9 @@ module Google
162
174
  credentials = @config.credentials
163
175
  # Use self-signed JWT if the endpoint is unchanged from default,
164
176
  # but only if the default endpoint does not have a region prefix.
165
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
166
- !@config.endpoint.split(".").first.include?("-")
177
+ enable_self_signed_jwt = @config.endpoint.nil? ||
178
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
179
+ !@config.endpoint.split(".").first.include?("-"))
167
180
  credentials ||= Credentials.default scope: @config.scope,
168
181
  enable_self_signed_jwt: enable_self_signed_jwt
169
182
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -174,10 +187,13 @@ module Google
174
187
 
175
188
  @secret_manager_service_stub = ::Gapic::ServiceStub.new(
176
189
  ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Stub,
177
- credentials: credentials,
178
- endpoint: @config.endpoint,
190
+ credentials: credentials,
191
+ endpoint: @config.endpoint,
192
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
193
+ universe_domain: @config.universe_domain,
179
194
  channel_args: @config.channel_args,
180
- interceptors: @config.interceptors
195
+ interceptors: @config.interceptors,
196
+ channel_pool_config: @config.channel_pool
181
197
  )
182
198
  end
183
199
 
@@ -1588,9 +1604,9 @@ module Google
1588
1604
  # end
1589
1605
  #
1590
1606
  # @!attribute [rw] endpoint
1591
- # The hostname or hostname:port of the service endpoint.
1592
- # Defaults to `"secretmanager.googleapis.com"`.
1593
- # @return [::String]
1607
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1608
+ # nil, indicating to use the default endpoint in the current universe domain.
1609
+ # @return [::String,nil]
1594
1610
  # @!attribute [rw] credentials
1595
1611
  # Credentials to send with calls. You may provide any of the following types:
1596
1612
  # * (`String`) The path to a service account key file in JSON format
@@ -1636,13 +1652,20 @@ module Google
1636
1652
  # @!attribute [rw] quota_project
1637
1653
  # A separate project against which to charge quota.
1638
1654
  # @return [::String]
1655
+ # @!attribute [rw] universe_domain
1656
+ # The universe domain within which to make requests. This determines the
1657
+ # default endpoint URL. The default value of nil uses the environment
1658
+ # universe (usually the default "googleapis.com" universe).
1659
+ # @return [::String,nil]
1639
1660
  #
1640
1661
  class Configuration
1641
1662
  extend ::Gapic::Config
1642
1663
 
1664
+ # @private
1665
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1643
1666
  DEFAULT_ENDPOINT = "secretmanager.googleapis.com"
1644
1667
 
1645
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1668
+ config_attr :endpoint, nil, ::String, nil
1646
1669
  config_attr :credentials, nil do |value|
1647
1670
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1648
1671
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1657,6 +1680,7 @@ module Google
1657
1680
  config_attr :metadata, nil, ::Hash, nil
1658
1681
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1659
1682
  config_attr :quota_project, nil, ::String, nil
1683
+ config_attr :universe_domain, nil, ::String, nil
1660
1684
 
1661
1685
  # @private
1662
1686
  def initialize parent_config = nil
@@ -1677,6 +1701,14 @@ module Google
1677
1701
  end
1678
1702
  end
1679
1703
 
1704
+ ##
1705
+ # Configuration for the channel pool
1706
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1707
+ #
1708
+ def channel_pool
1709
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1710
+ end
1711
+
1680
1712
  ##
1681
1713
  # Configuration RPC class for the SecretManagerService API.
1682
1714
  #
@@ -38,6 +38,9 @@ module Google
38
38
  # * {::Google::Cloud::SecretManager::V1beta1::SecretVersion SecretVersion}
39
39
  #
40
40
  class Client
41
+ # @private
42
+ DEFAULT_ENDPOINT_TEMPLATE = "secretmanager.$UNIVERSE_DOMAIN$"
43
+
41
44
  include Paths
42
45
 
43
46
  # @private
@@ -131,6 +134,15 @@ module Google
131
134
  @config
132
135
  end
133
136
 
137
+ ##
138
+ # The effective universe domain
139
+ #
140
+ # @return [String]
141
+ #
142
+ def universe_domain
143
+ @secret_manager_service_stub.universe_domain
144
+ end
145
+
134
146
  ##
135
147
  # Create a new SecretManagerService REST client object.
136
148
  #
@@ -158,8 +170,9 @@ module Google
158
170
  credentials = @config.credentials
159
171
  # Use self-signed JWT if the endpoint is unchanged from default,
160
172
  # but only if the default endpoint does not have a region prefix.
161
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
162
- !@config.endpoint.split(".").first.include?("-")
173
+ enable_self_signed_jwt = @config.endpoint.nil? ||
174
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
175
+ !@config.endpoint.split(".").first.include?("-"))
163
176
  credentials ||= Credentials.default scope: @config.scope,
164
177
  enable_self_signed_jwt: enable_self_signed_jwt
165
178
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -169,7 +182,12 @@ module Google
169
182
  @quota_project_id = @config.quota_project
170
183
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
171
184
 
172
- @secret_manager_service_stub = ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
185
+ @secret_manager_service_stub = ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::ServiceStub.new(
186
+ endpoint: @config.endpoint,
187
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
188
+ universe_domain: @config.universe_domain,
189
+ credentials: credentials
190
+ )
173
191
  end
174
192
 
175
193
  # Service calls
@@ -209,6 +227,26 @@ module Google
209
227
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::SecretManager::V1beta1::Secret>]
210
228
  #
211
229
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
230
+ #
231
+ # @example Basic example
232
+ # require "google/cloud/secret_manager/v1beta1"
233
+ #
234
+ # # Create a client object. The client can be reused for multiple calls.
235
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
236
+ #
237
+ # # Create a request. To set request fields, pass in keyword arguments.
238
+ # request = Google::Cloud::SecretManager::V1beta1::ListSecretsRequest.new
239
+ #
240
+ # # Call the list_secrets method.
241
+ # result = client.list_secrets request
242
+ #
243
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
244
+ # # over elements, and API calls will be issued to fetch pages as needed.
245
+ # result.each do |item|
246
+ # # Each element is of type ::Google::Cloud::SecretManager::V1beta1::Secret.
247
+ # p item
248
+ # end
249
+ #
212
250
  def list_secrets request, options = nil
213
251
  raise ::ArgumentError, "request must be provided" if request.nil?
214
252
 
@@ -281,6 +319,22 @@ module Google
281
319
  # @return [::Google::Cloud::SecretManager::V1beta1::Secret]
282
320
  #
283
321
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
322
+ #
323
+ # @example Basic example
324
+ # require "google/cloud/secret_manager/v1beta1"
325
+ #
326
+ # # Create a client object. The client can be reused for multiple calls.
327
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
328
+ #
329
+ # # Create a request. To set request fields, pass in keyword arguments.
330
+ # request = Google::Cloud::SecretManager::V1beta1::CreateSecretRequest.new
331
+ #
332
+ # # Call the create_secret method.
333
+ # result = client.create_secret request
334
+ #
335
+ # # The returned object is of type Google::Cloud::SecretManager::V1beta1::Secret.
336
+ # p result
337
+ #
284
338
  def create_secret request, options = nil
285
339
  raise ::ArgumentError, "request must be provided" if request.nil?
286
340
 
@@ -347,6 +401,22 @@ module Google
347
401
  # @return [::Google::Cloud::SecretManager::V1beta1::SecretVersion]
348
402
  #
349
403
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
404
+ #
405
+ # @example Basic example
406
+ # require "google/cloud/secret_manager/v1beta1"
407
+ #
408
+ # # Create a client object. The client can be reused for multiple calls.
409
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
410
+ #
411
+ # # Create a request. To set request fields, pass in keyword arguments.
412
+ # request = Google::Cloud::SecretManager::V1beta1::AddSecretVersionRequest.new
413
+ #
414
+ # # Call the add_secret_version method.
415
+ # result = client.add_secret_version request
416
+ #
417
+ # # The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
418
+ # p result
419
+ #
350
420
  def add_secret_version request, options = nil
351
421
  raise ::ArgumentError, "request must be provided" if request.nil?
352
422
 
@@ -409,6 +479,22 @@ module Google
409
479
  # @return [::Google::Cloud::SecretManager::V1beta1::Secret]
410
480
  #
411
481
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
482
+ #
483
+ # @example Basic example
484
+ # require "google/cloud/secret_manager/v1beta1"
485
+ #
486
+ # # Create a client object. The client can be reused for multiple calls.
487
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
488
+ #
489
+ # # Create a request. To set request fields, pass in keyword arguments.
490
+ # request = Google::Cloud::SecretManager::V1beta1::GetSecretRequest.new
491
+ #
492
+ # # Call the get_secret method.
493
+ # result = client.get_secret request
494
+ #
495
+ # # The returned object is of type Google::Cloud::SecretManager::V1beta1::Secret.
496
+ # p result
497
+ #
412
498
  def get_secret request, options = nil
413
499
  raise ::ArgumentError, "request must be provided" if request.nil?
414
500
 
@@ -473,6 +559,22 @@ module Google
473
559
  # @return [::Google::Cloud::SecretManager::V1beta1::Secret]
474
560
  #
475
561
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
562
+ #
563
+ # @example Basic example
564
+ # require "google/cloud/secret_manager/v1beta1"
565
+ #
566
+ # # Create a client object. The client can be reused for multiple calls.
567
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
568
+ #
569
+ # # Create a request. To set request fields, pass in keyword arguments.
570
+ # request = Google::Cloud::SecretManager::V1beta1::UpdateSecretRequest.new
571
+ #
572
+ # # Call the update_secret method.
573
+ # result = client.update_secret request
574
+ #
575
+ # # The returned object is of type Google::Cloud::SecretManager::V1beta1::Secret.
576
+ # p result
577
+ #
476
578
  def update_secret request, options = nil
477
579
  raise ::ArgumentError, "request must be provided" if request.nil?
478
580
 
@@ -536,6 +638,22 @@ module Google
536
638
  # @return [::Google::Protobuf::Empty]
537
639
  #
538
640
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
641
+ #
642
+ # @example Basic example
643
+ # require "google/cloud/secret_manager/v1beta1"
644
+ #
645
+ # # Create a client object. The client can be reused for multiple calls.
646
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
647
+ #
648
+ # # Create a request. To set request fields, pass in keyword arguments.
649
+ # request = Google::Cloud::SecretManager::V1beta1::DeleteSecretRequest.new
650
+ #
651
+ # # Call the delete_secret method.
652
+ # result = client.delete_secret request
653
+ #
654
+ # # The returned object is of type Google::Protobuf::Empty.
655
+ # p result
656
+ #
539
657
  def delete_secret request, options = nil
540
658
  raise ::ArgumentError, "request must be provided" if request.nil?
541
659
 
@@ -608,6 +726,26 @@ module Google
608
726
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::SecretManager::V1beta1::SecretVersion>]
609
727
  #
610
728
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
729
+ #
730
+ # @example Basic example
731
+ # require "google/cloud/secret_manager/v1beta1"
732
+ #
733
+ # # Create a client object. The client can be reused for multiple calls.
734
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
735
+ #
736
+ # # Create a request. To set request fields, pass in keyword arguments.
737
+ # request = Google::Cloud::SecretManager::V1beta1::ListSecretVersionsRequest.new
738
+ #
739
+ # # Call the list_secret_versions method.
740
+ # result = client.list_secret_versions request
741
+ #
742
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
743
+ # # over elements, and API calls will be issued to fetch pages as needed.
744
+ # result.each do |item|
745
+ # # Each element is of type ::Google::Cloud::SecretManager::V1beta1::SecretVersion.
746
+ # p item
747
+ # end
748
+ #
611
749
  def list_secret_versions request, options = nil
612
750
  raise ::ArgumentError, "request must be provided" if request.nil?
613
751
 
@@ -677,6 +815,22 @@ module Google
677
815
  # @return [::Google::Cloud::SecretManager::V1beta1::SecretVersion]
678
816
  #
679
817
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
818
+ #
819
+ # @example Basic example
820
+ # require "google/cloud/secret_manager/v1beta1"
821
+ #
822
+ # # Create a client object. The client can be reused for multiple calls.
823
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
824
+ #
825
+ # # Create a request. To set request fields, pass in keyword arguments.
826
+ # request = Google::Cloud::SecretManager::V1beta1::GetSecretVersionRequest.new
827
+ #
828
+ # # Call the get_secret_version method.
829
+ # result = client.get_secret_version request
830
+ #
831
+ # # The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
832
+ # p result
833
+ #
680
834
  def get_secret_version request, options = nil
681
835
  raise ::ArgumentError, "request must be provided" if request.nil?
682
836
 
@@ -743,6 +897,22 @@ module Google
743
897
  # @return [::Google::Cloud::SecretManager::V1beta1::AccessSecretVersionResponse]
744
898
  #
745
899
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
900
+ #
901
+ # @example Basic example
902
+ # require "google/cloud/secret_manager/v1beta1"
903
+ #
904
+ # # Create a client object. The client can be reused for multiple calls.
905
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
906
+ #
907
+ # # Create a request. To set request fields, pass in keyword arguments.
908
+ # request = Google::Cloud::SecretManager::V1beta1::AccessSecretVersionRequest.new
909
+ #
910
+ # # Call the access_secret_version method.
911
+ # result = client.access_secret_version request
912
+ #
913
+ # # The returned object is of type Google::Cloud::SecretManager::V1beta1::AccessSecretVersionResponse.
914
+ # p result
915
+ #
746
916
  def access_secret_version request, options = nil
747
917
  raise ::ArgumentError, "request must be provided" if request.nil?
748
918
 
@@ -809,6 +979,22 @@ module Google
809
979
  # @return [::Google::Cloud::SecretManager::V1beta1::SecretVersion]
810
980
  #
811
981
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
982
+ #
983
+ # @example Basic example
984
+ # require "google/cloud/secret_manager/v1beta1"
985
+ #
986
+ # # Create a client object. The client can be reused for multiple calls.
987
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
988
+ #
989
+ # # Create a request. To set request fields, pass in keyword arguments.
990
+ # request = Google::Cloud::SecretManager::V1beta1::DisableSecretVersionRequest.new
991
+ #
992
+ # # Call the disable_secret_version method.
993
+ # result = client.disable_secret_version request
994
+ #
995
+ # # The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
996
+ # p result
997
+ #
812
998
  def disable_secret_version request, options = nil
813
999
  raise ::ArgumentError, "request must be provided" if request.nil?
814
1000
 
@@ -875,6 +1061,22 @@ module Google
875
1061
  # @return [::Google::Cloud::SecretManager::V1beta1::SecretVersion]
876
1062
  #
877
1063
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1064
+ #
1065
+ # @example Basic example
1066
+ # require "google/cloud/secret_manager/v1beta1"
1067
+ #
1068
+ # # Create a client object. The client can be reused for multiple calls.
1069
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
1070
+ #
1071
+ # # Create a request. To set request fields, pass in keyword arguments.
1072
+ # request = Google::Cloud::SecretManager::V1beta1::EnableSecretVersionRequest.new
1073
+ #
1074
+ # # Call the enable_secret_version method.
1075
+ # result = client.enable_secret_version request
1076
+ #
1077
+ # # The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
1078
+ # p result
1079
+ #
878
1080
  def enable_secret_version request, options = nil
879
1081
  raise ::ArgumentError, "request must be provided" if request.nil?
880
1082
 
@@ -942,6 +1144,22 @@ module Google
942
1144
  # @return [::Google::Cloud::SecretManager::V1beta1::SecretVersion]
943
1145
  #
944
1146
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1147
+ #
1148
+ # @example Basic example
1149
+ # require "google/cloud/secret_manager/v1beta1"
1150
+ #
1151
+ # # Create a client object. The client can be reused for multiple calls.
1152
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
1153
+ #
1154
+ # # Create a request. To set request fields, pass in keyword arguments.
1155
+ # request = Google::Cloud::SecretManager::V1beta1::DestroySecretVersionRequest.new
1156
+ #
1157
+ # # Call the destroy_secret_version method.
1158
+ # result = client.destroy_secret_version request
1159
+ #
1160
+ # # The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
1161
+ # p result
1162
+ #
945
1163
  def destroy_secret_version request, options = nil
946
1164
  raise ::ArgumentError, "request must be provided" if request.nil?
947
1165
 
@@ -1020,6 +1238,22 @@ module Google
1020
1238
  # @return [::Google::Iam::V1::Policy]
1021
1239
  #
1022
1240
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1241
+ #
1242
+ # @example Basic example
1243
+ # require "google/cloud/secret_manager/v1beta1"
1244
+ #
1245
+ # # Create a client object. The client can be reused for multiple calls.
1246
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
1247
+ #
1248
+ # # Create a request. To set request fields, pass in keyword arguments.
1249
+ # request = Google::Iam::V1::SetIamPolicyRequest.new
1250
+ #
1251
+ # # Call the set_iam_policy method.
1252
+ # result = client.set_iam_policy request
1253
+ #
1254
+ # # The returned object is of type Google::Iam::V1::Policy.
1255
+ # p result
1256
+ #
1023
1257
  def set_iam_policy request, options = nil
1024
1258
  raise ::ArgumentError, "request must be provided" if request.nil?
1025
1259
 
@@ -1087,6 +1321,22 @@ module Google
1087
1321
  # @return [::Google::Iam::V1::Policy]
1088
1322
  #
1089
1323
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1324
+ #
1325
+ # @example Basic example
1326
+ # require "google/cloud/secret_manager/v1beta1"
1327
+ #
1328
+ # # Create a client object. The client can be reused for multiple calls.
1329
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
1330
+ #
1331
+ # # Create a request. To set request fields, pass in keyword arguments.
1332
+ # request = Google::Iam::V1::GetIamPolicyRequest.new
1333
+ #
1334
+ # # Call the get_iam_policy method.
1335
+ # result = client.get_iam_policy request
1336
+ #
1337
+ # # The returned object is of type Google::Iam::V1::Policy.
1338
+ # p result
1339
+ #
1090
1340
  def get_iam_policy request, options = nil
1091
1341
  raise ::ArgumentError, "request must be provided" if request.nil?
1092
1342
 
@@ -1161,6 +1411,22 @@ module Google
1161
1411
  # @return [::Google::Iam::V1::TestIamPermissionsResponse]
1162
1412
  #
1163
1413
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1414
+ #
1415
+ # @example Basic example
1416
+ # require "google/cloud/secret_manager/v1beta1"
1417
+ #
1418
+ # # Create a client object. The client can be reused for multiple calls.
1419
+ # client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Rest::Client.new
1420
+ #
1421
+ # # Create a request. To set request fields, pass in keyword arguments.
1422
+ # request = Google::Iam::V1::TestIamPermissionsRequest.new
1423
+ #
1424
+ # # Call the test_iam_permissions method.
1425
+ # result = client.test_iam_permissions request
1426
+ #
1427
+ # # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
1428
+ # p result
1429
+ #
1164
1430
  def test_iam_permissions request, options = nil
1165
1431
  raise ::ArgumentError, "request must be provided" if request.nil?
1166
1432
 
@@ -1226,9 +1492,9 @@ module Google
1226
1492
  # end
1227
1493
  #
1228
1494
  # @!attribute [rw] endpoint
1229
- # The hostname or hostname:port of the service endpoint.
1230
- # Defaults to `"secretmanager.googleapis.com"`.
1231
- # @return [::String]
1495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1496
+ # nil, indicating to use the default endpoint in the current universe domain.
1497
+ # @return [::String,nil]
1232
1498
  # @!attribute [rw] credentials
1233
1499
  # Credentials to send with calls. You may provide any of the following types:
1234
1500
  # * (`String`) The path to a service account key file in JSON format
@@ -1265,13 +1531,20 @@ module Google
1265
1531
  # @!attribute [rw] quota_project
1266
1532
  # A separate project against which to charge quota.
1267
1533
  # @return [::String]
1534
+ # @!attribute [rw] universe_domain
1535
+ # The universe domain within which to make requests. This determines the
1536
+ # default endpoint URL. The default value of nil uses the environment
1537
+ # universe (usually the default "googleapis.com" universe).
1538
+ # @return [::String,nil]
1268
1539
  #
1269
1540
  class Configuration
1270
1541
  extend ::Gapic::Config
1271
1542
 
1543
+ # @private
1544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1272
1545
  DEFAULT_ENDPOINT = "secretmanager.googleapis.com"
1273
1546
 
1274
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1547
+ config_attr :endpoint, nil, ::String, nil
1275
1548
  config_attr :credentials, nil do |value|
1276
1549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1277
1550
  allowed.any? { |klass| klass === value }
@@ -1283,6 +1556,7 @@ module Google
1283
1556
  config_attr :metadata, nil, ::Hash, nil
1284
1557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1285
1558
  config_attr :quota_project, nil, ::String, nil
1559
+ config_attr :universe_domain, nil, ::String, nil
1286
1560
 
1287
1561
  # @private
1288
1562
  def initialize parent_config = nil
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the list_secrets REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module SecretManager
23
23
  module V1beta1
24
- VERSION = "0.12.2"
24
+ VERSION = "0.14.0"
25
25
  end
26
26
  end
27
27
  end
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-secret_manager-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.12.2
4
+ version: 0.14.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-08-04 00:00:00.000000000 Z
11
+ date: 2024-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.19.1
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
233
233
  - !ruby/object:Gem::Version
234
234
  version: '0'
235
235
  requirements: []
236
- rubygems_version: 3.4.2
236
+ rubygems_version: 3.5.3
237
237
  signing_key:
238
238
  specification_version: 4
239
239
  summary: Stores sensitive data such as API keys, passwords, and certificates. Provides