google-apis-secretmanager_v1 0.38.0 → 0.39.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: ae54fa5dd7dae5c662b51422a978ef96f4c55b2eef944aa7ce2bb1624649ead1
4
- data.tar.gz: 6f0a83447788400917e55f85d8b9de3bae7bd5c70c551b8c529e50e7c8b72998
3
+ metadata.gz: ec144097eabea0b6d6f9ad901ff79e24cceacae34e10a3699fcfe5d75afdd736
4
+ data.tar.gz: 110708693afa8b79dbdf89b27c95d7cc5bee1ff1eae523f7126f8a0893ed320b
5
5
  SHA512:
6
- metadata.gz: 6728ba424c390d6db9234cbc77dca5d599fe56295aae331e7d9039dd3c05e1b214c4b1bf49546938797b8f32c89bdc1e9f932848b7bb1d02f02ebfe41c22d9fc
7
- data.tar.gz: f006c49769a2e636d67513f8d7c0bd384cf3617cc1605e89d73eecae00707a71af01af79091b7bfedd0d05ca77ca5cc1ba92146d582c4e1b7215a8d198fe301d
6
+ metadata.gz: cbe43b3e51a28eb74b037e1cfa0e3c2f4e43e2db7d9a4b09f327dc0fe4e2e3bdb3d8be7e42d71ae8b80fe74693e8e0d5f335b63ce9cd957405606b152dc328dc
7
+ data.tar.gz: b9ce7f227ecbb17ec0070e52c2b9a5f51ed28c48043aadd0ebd85d006ab2239a187402ed19666a415f55f5c6945e4d3adff52d0c54773d7a829886ac1b1c371d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-secretmanager_v1
2
2
 
3
+ ### v0.39.0 (2024-02-04)
4
+
5
+ * Regenerated from discovery document revision 20240126
6
+ * Regenerated using generator version 0.13.1
7
+
3
8
  ### v0.38.0 (2024-01-23)
4
9
 
5
10
  * Regenerated using generator version 0.13.0
@@ -27,7 +27,7 @@ module Google
27
27
  include Google::Apis::Core::Hashable
28
28
 
29
29
  # The resource name of the SecretVersion in the format `projects/*/secrets/*/
30
- # versions/*`.
30
+ # versions/*` or `projects/*/locations/*/secrets/*/versions/*`.
31
31
  # Corresponds to the JSON property `name`
32
32
  # @return [String]
33
33
  attr_accessor :name
@@ -262,7 +262,10 @@ module Google
262
262
  attr_accessor :members
263
263
 
264
264
  # Role that is assigned to the list of `members`, or principals. For example, `
265
- # roles/viewer`, `roles/editor`, or `roles/owner`.
265
+ # roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM
266
+ # roles and permissions, see the [IAM documentation](https://cloud.google.com/
267
+ # iam/docs/roles-overview). For a list of the available pre-defined roles, see [
268
+ # here](https://cloud.google.com/iam/docs/understanding-roles).
266
269
  # Corresponds to the JSON property `role`
267
270
  # @return [String]
268
271
  attr_accessor :role
@@ -908,8 +911,8 @@ module Google
908
911
  # characters. An alias string must start with a letter and cannot be the string '
909
912
  # latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret.
910
913
  # Version-Alias pairs will be viewable via GetSecret and modifiable via
911
- # UpdateSecret. At launch Access by Allias will only be supported on
912
- # GetSecretVersion and AccessSecretVersion.
914
+ # UpdateSecret. Access by alias is only be supported on GetSecretVersion and
915
+ # AccessSecretVersion.
913
916
  # Corresponds to the JSON property `versionAliases`
914
917
  # @return [Hash<String,Fixnum>]
915
918
  attr_accessor :version_aliases
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module SecretmanagerV1
18
18
  # Version of the google-apis-secretmanager_v1 gem
19
- GEM_VERSION = "0.38.0"
19
+ GEM_VERSION = "0.39.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.13.0"
22
+ GENERATOR_VERSION = "0.13.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20231215"
25
+ REVISION = "20240126"
26
26
  end
27
27
  end
28
28
  end
@@ -129,7 +129,573 @@ module Google
129
129
  # existing Secret.
130
130
  # @param [String] parent
131
131
  # Required. The resource name of the Secret to associate with the SecretVersion
132
- # in the format `projects/*/secrets/*`.
132
+ # in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.
133
+ # @param [Google::Apis::SecretmanagerV1::AddSecretVersionRequest] add_secret_version_request_object
134
+ # @param [String] fields
135
+ # Selector specifying which fields to include in a partial response.
136
+ # @param [String] quota_user
137
+ # Available to use for quota purposes for server-side applications. Can be any
138
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
139
+ # @param [Google::Apis::RequestOptions] options
140
+ # Request-specific options
141
+ #
142
+ # @yield [result, err] Result & error if block supplied
143
+ # @yieldparam result [Google::Apis::SecretmanagerV1::SecretVersion] parsed result object
144
+ # @yieldparam err [StandardError] error object if request failed
145
+ #
146
+ # @return [Google::Apis::SecretmanagerV1::SecretVersion]
147
+ #
148
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
149
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
150
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
151
+ def add_project_location_secret_version(parent, add_secret_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
152
+ command = make_simple_command(:post, 'v1/{+parent}:addVersion', options)
153
+ command.request_representation = Google::Apis::SecretmanagerV1::AddSecretVersionRequest::Representation
154
+ command.request_object = add_secret_version_request_object
155
+ command.response_representation = Google::Apis::SecretmanagerV1::SecretVersion::Representation
156
+ command.response_class = Google::Apis::SecretmanagerV1::SecretVersion
157
+ command.params['parent'] = parent unless parent.nil?
158
+ command.query['fields'] = fields unless fields.nil?
159
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
160
+ execute_or_queue_command(command, &block)
161
+ end
162
+
163
+ # Creates a new Secret containing no SecretVersions.
164
+ # @param [String] parent
165
+ # Required. The resource name of the project to associate with the Secret, in
166
+ # the format `projects/*` or `projects/*/locations/*`.
167
+ # @param [Google::Apis::SecretmanagerV1::Secret] secret_object
168
+ # @param [String] secret_id
169
+ # Required. This must be unique within the project. A secret ID is a string with
170
+ # a maximum length of 255 characters and can contain uppercase and lowercase
171
+ # letters, numerals, and the hyphen (`-`) and underscore (`_`) characters.
172
+ # @param [String] fields
173
+ # Selector specifying which fields to include in a partial response.
174
+ # @param [String] quota_user
175
+ # Available to use for quota purposes for server-side applications. Can be any
176
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
177
+ # @param [Google::Apis::RequestOptions] options
178
+ # Request-specific options
179
+ #
180
+ # @yield [result, err] Result & error if block supplied
181
+ # @yieldparam result [Google::Apis::SecretmanagerV1::Secret] parsed result object
182
+ # @yieldparam err [StandardError] error object if request failed
183
+ #
184
+ # @return [Google::Apis::SecretmanagerV1::Secret]
185
+ #
186
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
187
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
188
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
189
+ def create_project_location_secret(parent, secret_object = nil, secret_id: nil, fields: nil, quota_user: nil, options: nil, &block)
190
+ command = make_simple_command(:post, 'v1/{+parent}/secrets', options)
191
+ command.request_representation = Google::Apis::SecretmanagerV1::Secret::Representation
192
+ command.request_object = secret_object
193
+ command.response_representation = Google::Apis::SecretmanagerV1::Secret::Representation
194
+ command.response_class = Google::Apis::SecretmanagerV1::Secret
195
+ command.params['parent'] = parent unless parent.nil?
196
+ command.query['secretId'] = secret_id unless secret_id.nil?
197
+ command.query['fields'] = fields unless fields.nil?
198
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
199
+ execute_or_queue_command(command, &block)
200
+ end
201
+
202
+ # Deletes a Secret.
203
+ # @param [String] name
204
+ # Required. The resource name of the Secret to delete in the format `projects/*/
205
+ # secrets/*`.
206
+ # @param [String] etag
207
+ # Optional. Etag of the Secret. The request succeeds if it matches the etag of
208
+ # the currently stored secret object. If the etag is omitted, the request
209
+ # succeeds.
210
+ # @param [String] fields
211
+ # Selector specifying which fields to include in a partial response.
212
+ # @param [String] quota_user
213
+ # Available to use for quota purposes for server-side applications. Can be any
214
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
215
+ # @param [Google::Apis::RequestOptions] options
216
+ # Request-specific options
217
+ #
218
+ # @yield [result, err] Result & error if block supplied
219
+ # @yieldparam result [Google::Apis::SecretmanagerV1::Empty] parsed result object
220
+ # @yieldparam err [StandardError] error object if request failed
221
+ #
222
+ # @return [Google::Apis::SecretmanagerV1::Empty]
223
+ #
224
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
225
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
226
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
227
+ def delete_project_location_secret(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
228
+ command = make_simple_command(:delete, 'v1/{+name}', options)
229
+ command.response_representation = Google::Apis::SecretmanagerV1::Empty::Representation
230
+ command.response_class = Google::Apis::SecretmanagerV1::Empty
231
+ command.params['name'] = name unless name.nil?
232
+ command.query['etag'] = etag unless etag.nil?
233
+ command.query['fields'] = fields unless fields.nil?
234
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
235
+ execute_or_queue_command(command, &block)
236
+ end
237
+
238
+ # Gets metadata for a given Secret.
239
+ # @param [String] name
240
+ # Required. The resource name of the Secret, in the format `projects/*/secrets/*`
241
+ # or `projects/*/locations/*/secrets/*`.
242
+ # @param [String] fields
243
+ # Selector specifying which fields to include in a partial response.
244
+ # @param [String] quota_user
245
+ # Available to use for quota purposes for server-side applications. Can be any
246
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
247
+ # @param [Google::Apis::RequestOptions] options
248
+ # Request-specific options
249
+ #
250
+ # @yield [result, err] Result & error if block supplied
251
+ # @yieldparam result [Google::Apis::SecretmanagerV1::Secret] parsed result object
252
+ # @yieldparam err [StandardError] error object if request failed
253
+ #
254
+ # @return [Google::Apis::SecretmanagerV1::Secret]
255
+ #
256
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
257
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
258
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
259
+ def get_project_location_secret(name, fields: nil, quota_user: nil, options: nil, &block)
260
+ command = make_simple_command(:get, 'v1/{+name}', options)
261
+ command.response_representation = Google::Apis::SecretmanagerV1::Secret::Representation
262
+ command.response_class = Google::Apis::SecretmanagerV1::Secret
263
+ command.params['name'] = name unless name.nil?
264
+ command.query['fields'] = fields unless fields.nil?
265
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
266
+ execute_or_queue_command(command, &block)
267
+ end
268
+
269
+ # Gets the access control policy for a secret. Returns empty policy if the
270
+ # secret exists and does not have a policy set.
271
+ # @param [String] resource
272
+ # REQUIRED: The resource for which the policy is being requested. See [Resource
273
+ # names](https://cloud.google.com/apis/design/resource_names) for the
274
+ # appropriate value for this field.
275
+ # @param [Fixnum] options_requested_policy_version
276
+ # Optional. The maximum policy version that will be used to format the policy.
277
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
278
+ # rejected. Requests for policies with any conditional role bindings must
279
+ # specify version 3. Policies with no conditional role bindings may specify any
280
+ # valid value or leave the field unset. The policy in the response might use the
281
+ # policy version that you specified, or it might use a lower policy version. For
282
+ # example, if you specify version 3, but the policy has no conditional role
283
+ # bindings, the response uses version 1. To learn which resources support
284
+ # conditions in their IAM policies, see the [IAM documentation](https://cloud.
285
+ # google.com/iam/help/conditions/resource-policies).
286
+ # @param [String] fields
287
+ # Selector specifying which fields to include in a partial response.
288
+ # @param [String] quota_user
289
+ # Available to use for quota purposes for server-side applications. Can be any
290
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
291
+ # @param [Google::Apis::RequestOptions] options
292
+ # Request-specific options
293
+ #
294
+ # @yield [result, err] Result & error if block supplied
295
+ # @yieldparam result [Google::Apis::SecretmanagerV1::Policy] parsed result object
296
+ # @yieldparam err [StandardError] error object if request failed
297
+ #
298
+ # @return [Google::Apis::SecretmanagerV1::Policy]
299
+ #
300
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
301
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
302
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
303
+ def get_project_location_secret_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
304
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
305
+ command.response_representation = Google::Apis::SecretmanagerV1::Policy::Representation
306
+ command.response_class = Google::Apis::SecretmanagerV1::Policy
307
+ command.params['resource'] = resource unless resource.nil?
308
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
309
+ command.query['fields'] = fields unless fields.nil?
310
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
311
+ execute_or_queue_command(command, &block)
312
+ end
313
+
314
+ # Lists Secrets.
315
+ # @param [String] parent
316
+ # Required. The resource name of the project associated with the Secrets, in the
317
+ # format `projects/*` or `projects/*/locations/*`
318
+ # @param [String] filter
319
+ # Optional. Filter string, adhering to the rules in [List-operation filtering](
320
+ # https://cloud.google.com/secret-manager/docs/filtering). List only secrets
321
+ # matching the filter. If filter is empty, all secrets are listed.
322
+ # @param [Fixnum] page_size
323
+ # Optional. The maximum number of results to be returned in a single page. If
324
+ # set to 0, the server decides the number of results to return. If the number is
325
+ # greater than 25000, it is capped at 25000.
326
+ # @param [String] page_token
327
+ # Optional. Pagination token, returned earlier via ListSecretsResponse.
328
+ # next_page_token.
329
+ # @param [String] fields
330
+ # Selector specifying which fields to include in a partial response.
331
+ # @param [String] quota_user
332
+ # Available to use for quota purposes for server-side applications. Can be any
333
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
334
+ # @param [Google::Apis::RequestOptions] options
335
+ # Request-specific options
336
+ #
337
+ # @yield [result, err] Result & error if block supplied
338
+ # @yieldparam result [Google::Apis::SecretmanagerV1::ListSecretsResponse] parsed result object
339
+ # @yieldparam err [StandardError] error object if request failed
340
+ #
341
+ # @return [Google::Apis::SecretmanagerV1::ListSecretsResponse]
342
+ #
343
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
344
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
345
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
346
+ def list_project_location_secrets(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
347
+ command = make_simple_command(:get, 'v1/{+parent}/secrets', options)
348
+ command.response_representation = Google::Apis::SecretmanagerV1::ListSecretsResponse::Representation
349
+ command.response_class = Google::Apis::SecretmanagerV1::ListSecretsResponse
350
+ command.params['parent'] = parent unless parent.nil?
351
+ command.query['filter'] = filter unless filter.nil?
352
+ command.query['pageSize'] = page_size unless page_size.nil?
353
+ command.query['pageToken'] = page_token unless page_token.nil?
354
+ command.query['fields'] = fields unless fields.nil?
355
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
356
+ execute_or_queue_command(command, &block)
357
+ end
358
+
359
+ # Updates metadata of an existing Secret.
360
+ # @param [String] name
361
+ # Output only. The resource name of the Secret in the format `projects/*/secrets/
362
+ # *`.
363
+ # @param [Google::Apis::SecretmanagerV1::Secret] secret_object
364
+ # @param [String] update_mask
365
+ # Required. Specifies the fields to be updated.
366
+ # @param [String] fields
367
+ # Selector specifying which fields to include in a partial response.
368
+ # @param [String] quota_user
369
+ # Available to use for quota purposes for server-side applications. Can be any
370
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
371
+ # @param [Google::Apis::RequestOptions] options
372
+ # Request-specific options
373
+ #
374
+ # @yield [result, err] Result & error if block supplied
375
+ # @yieldparam result [Google::Apis::SecretmanagerV1::Secret] parsed result object
376
+ # @yieldparam err [StandardError] error object if request failed
377
+ #
378
+ # @return [Google::Apis::SecretmanagerV1::Secret]
379
+ #
380
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
381
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
382
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
383
+ def patch_project_location_secret(name, secret_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
384
+ command = make_simple_command(:patch, 'v1/{+name}', options)
385
+ command.request_representation = Google::Apis::SecretmanagerV1::Secret::Representation
386
+ command.request_object = secret_object
387
+ command.response_representation = Google::Apis::SecretmanagerV1::Secret::Representation
388
+ command.response_class = Google::Apis::SecretmanagerV1::Secret
389
+ command.params['name'] = name unless name.nil?
390
+ command.query['updateMask'] = update_mask unless update_mask.nil?
391
+ command.query['fields'] = fields unless fields.nil?
392
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
393
+ execute_or_queue_command(command, &block)
394
+ end
395
+
396
+ # Sets the access control policy on the specified secret. Replaces any existing
397
+ # policy. Permissions on SecretVersions are enforced according to the policy set
398
+ # on the associated Secret.
399
+ # @param [String] resource
400
+ # REQUIRED: The resource for which the policy is being specified. See [Resource
401
+ # names](https://cloud.google.com/apis/design/resource_names) for the
402
+ # appropriate value for this field.
403
+ # @param [Google::Apis::SecretmanagerV1::SetIamPolicyRequest] set_iam_policy_request_object
404
+ # @param [String] fields
405
+ # Selector specifying which fields to include in a partial response.
406
+ # @param [String] quota_user
407
+ # Available to use for quota purposes for server-side applications. Can be any
408
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
409
+ # @param [Google::Apis::RequestOptions] options
410
+ # Request-specific options
411
+ #
412
+ # @yield [result, err] Result & error if block supplied
413
+ # @yieldparam result [Google::Apis::SecretmanagerV1::Policy] parsed result object
414
+ # @yieldparam err [StandardError] error object if request failed
415
+ #
416
+ # @return [Google::Apis::SecretmanagerV1::Policy]
417
+ #
418
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
419
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
420
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
421
+ def set_project_location_secret_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
422
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
423
+ command.request_representation = Google::Apis::SecretmanagerV1::SetIamPolicyRequest::Representation
424
+ command.request_object = set_iam_policy_request_object
425
+ command.response_representation = Google::Apis::SecretmanagerV1::Policy::Representation
426
+ command.response_class = Google::Apis::SecretmanagerV1::Policy
427
+ command.params['resource'] = resource unless resource.nil?
428
+ command.query['fields'] = fields unless fields.nil?
429
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
430
+ execute_or_queue_command(command, &block)
431
+ end
432
+
433
+ # Returns permissions that a caller has for the specified secret. If the secret
434
+ # does not exist, this call returns an empty set of permissions, not a NOT_FOUND
435
+ # error. Note: This operation is designed to be used for building permission-
436
+ # aware UIs and command-line tools, not for authorization checking. This
437
+ # operation may "fail open" without warning.
438
+ # @param [String] resource
439
+ # REQUIRED: The resource for which the policy detail is being requested. See [
440
+ # Resource names](https://cloud.google.com/apis/design/resource_names) for the
441
+ # appropriate value for this field.
442
+ # @param [Google::Apis::SecretmanagerV1::TestIamPermissionsRequest] test_iam_permissions_request_object
443
+ # @param [String] fields
444
+ # Selector specifying which fields to include in a partial response.
445
+ # @param [String] quota_user
446
+ # Available to use for quota purposes for server-side applications. Can be any
447
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
448
+ # @param [Google::Apis::RequestOptions] options
449
+ # Request-specific options
450
+ #
451
+ # @yield [result, err] Result & error if block supplied
452
+ # @yieldparam result [Google::Apis::SecretmanagerV1::TestIamPermissionsResponse] parsed result object
453
+ # @yieldparam err [StandardError] error object if request failed
454
+ #
455
+ # @return [Google::Apis::SecretmanagerV1::TestIamPermissionsResponse]
456
+ #
457
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
458
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
459
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
460
+ def test_project_location_secret_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
461
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
462
+ command.request_representation = Google::Apis::SecretmanagerV1::TestIamPermissionsRequest::Representation
463
+ command.request_object = test_iam_permissions_request_object
464
+ command.response_representation = Google::Apis::SecretmanagerV1::TestIamPermissionsResponse::Representation
465
+ command.response_class = Google::Apis::SecretmanagerV1::TestIamPermissionsResponse
466
+ command.params['resource'] = resource unless resource.nil?
467
+ command.query['fields'] = fields unless fields.nil?
468
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
469
+ execute_or_queue_command(command, &block)
470
+ end
471
+
472
+ # Accesses a SecretVersion. This call returns the secret data. `projects/*/
473
+ # secrets/*/versions/latest` is an alias to the most recently created
474
+ # SecretVersion.
475
+ # @param [String] name
476
+ # Required. The resource name of the SecretVersion in the format `projects/*/
477
+ # secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `
478
+ # projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/
479
+ # versions/latest` is an alias to the most recently created SecretVersion.
480
+ # @param [String] fields
481
+ # Selector specifying which fields to include in a partial response.
482
+ # @param [String] quota_user
483
+ # Available to use for quota purposes for server-side applications. Can be any
484
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
485
+ # @param [Google::Apis::RequestOptions] options
486
+ # Request-specific options
487
+ #
488
+ # @yield [result, err] Result & error if block supplied
489
+ # @yieldparam result [Google::Apis::SecretmanagerV1::AccessSecretVersionResponse] parsed result object
490
+ # @yieldparam err [StandardError] error object if request failed
491
+ #
492
+ # @return [Google::Apis::SecretmanagerV1::AccessSecretVersionResponse]
493
+ #
494
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
495
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
496
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
497
+ def access_project_location_secret_version(name, fields: nil, quota_user: nil, options: nil, &block)
498
+ command = make_simple_command(:get, 'v1/{+name}:access', options)
499
+ command.response_representation = Google::Apis::SecretmanagerV1::AccessSecretVersionResponse::Representation
500
+ command.response_class = Google::Apis::SecretmanagerV1::AccessSecretVersionResponse
501
+ command.params['name'] = name unless name.nil?
502
+ command.query['fields'] = fields unless fields.nil?
503
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
504
+ execute_or_queue_command(command, &block)
505
+ end
506
+
507
+ # Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and
508
+ # irrevocably destroys the secret data.
509
+ # @param [String] name
510
+ # Required. The resource name of the SecretVersion to destroy in the format `
511
+ # projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/
512
+ # *`.
513
+ # @param [Google::Apis::SecretmanagerV1::DestroySecretVersionRequest] destroy_secret_version_request_object
514
+ # @param [String] fields
515
+ # Selector specifying which fields to include in a partial response.
516
+ # @param [String] quota_user
517
+ # Available to use for quota purposes for server-side applications. Can be any
518
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
519
+ # @param [Google::Apis::RequestOptions] options
520
+ # Request-specific options
521
+ #
522
+ # @yield [result, err] Result & error if block supplied
523
+ # @yieldparam result [Google::Apis::SecretmanagerV1::SecretVersion] parsed result object
524
+ # @yieldparam err [StandardError] error object if request failed
525
+ #
526
+ # @return [Google::Apis::SecretmanagerV1::SecretVersion]
527
+ #
528
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
529
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
530
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
531
+ def destroy_project_location_secret_version(name, destroy_secret_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
532
+ command = make_simple_command(:post, 'v1/{+name}:destroy', options)
533
+ command.request_representation = Google::Apis::SecretmanagerV1::DestroySecretVersionRequest::Representation
534
+ command.request_object = destroy_secret_version_request_object
535
+ command.response_representation = Google::Apis::SecretmanagerV1::SecretVersion::Representation
536
+ command.response_class = Google::Apis::SecretmanagerV1::SecretVersion
537
+ command.params['name'] = name unless name.nil?
538
+ command.query['fields'] = fields unless fields.nil?
539
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
540
+ execute_or_queue_command(command, &block)
541
+ end
542
+
543
+ # Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.
544
+ # @param [String] name
545
+ # Required. The resource name of the SecretVersion to disable in the format `
546
+ # projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/
547
+ # *`.
548
+ # @param [Google::Apis::SecretmanagerV1::DisableSecretVersionRequest] disable_secret_version_request_object
549
+ # @param [String] fields
550
+ # Selector specifying which fields to include in a partial response.
551
+ # @param [String] quota_user
552
+ # Available to use for quota purposes for server-side applications. Can be any
553
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
554
+ # @param [Google::Apis::RequestOptions] options
555
+ # Request-specific options
556
+ #
557
+ # @yield [result, err] Result & error if block supplied
558
+ # @yieldparam result [Google::Apis::SecretmanagerV1::SecretVersion] parsed result object
559
+ # @yieldparam err [StandardError] error object if request failed
560
+ #
561
+ # @return [Google::Apis::SecretmanagerV1::SecretVersion]
562
+ #
563
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
564
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
565
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
566
+ def disable_project_location_secret_version(name, disable_secret_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
567
+ command = make_simple_command(:post, 'v1/{+name}:disable', options)
568
+ command.request_representation = Google::Apis::SecretmanagerV1::DisableSecretVersionRequest::Representation
569
+ command.request_object = disable_secret_version_request_object
570
+ command.response_representation = Google::Apis::SecretmanagerV1::SecretVersion::Representation
571
+ command.response_class = Google::Apis::SecretmanagerV1::SecretVersion
572
+ command.params['name'] = name unless name.nil?
573
+ command.query['fields'] = fields unless fields.nil?
574
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
575
+ execute_or_queue_command(command, &block)
576
+ end
577
+
578
+ # Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.
579
+ # @param [String] name
580
+ # Required. The resource name of the SecretVersion to enable in the format `
581
+ # projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/
582
+ # *`.
583
+ # @param [Google::Apis::SecretmanagerV1::EnableSecretVersionRequest] enable_secret_version_request_object
584
+ # @param [String] fields
585
+ # Selector specifying which fields to include in a partial response.
586
+ # @param [String] quota_user
587
+ # Available to use for quota purposes for server-side applications. Can be any
588
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
589
+ # @param [Google::Apis::RequestOptions] options
590
+ # Request-specific options
591
+ #
592
+ # @yield [result, err] Result & error if block supplied
593
+ # @yieldparam result [Google::Apis::SecretmanagerV1::SecretVersion] parsed result object
594
+ # @yieldparam err [StandardError] error object if request failed
595
+ #
596
+ # @return [Google::Apis::SecretmanagerV1::SecretVersion]
597
+ #
598
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
599
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
600
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
601
+ def enable_project_location_secret_version(name, enable_secret_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
602
+ command = make_simple_command(:post, 'v1/{+name}:enable', options)
603
+ command.request_representation = Google::Apis::SecretmanagerV1::EnableSecretVersionRequest::Representation
604
+ command.request_object = enable_secret_version_request_object
605
+ command.response_representation = Google::Apis::SecretmanagerV1::SecretVersion::Representation
606
+ command.response_class = Google::Apis::SecretmanagerV1::SecretVersion
607
+ command.params['name'] = name unless name.nil?
608
+ command.query['fields'] = fields unless fields.nil?
609
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
610
+ execute_or_queue_command(command, &block)
611
+ end
612
+
613
+ # Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is
614
+ # an alias to the most recently created SecretVersion.
615
+ # @param [String] name
616
+ # Required. The resource name of the SecretVersion in the format `projects/*/
617
+ # secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `
618
+ # projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/
619
+ # versions/latest` is an alias to the most recently created SecretVersion.
620
+ # @param [String] fields
621
+ # Selector specifying which fields to include in a partial response.
622
+ # @param [String] quota_user
623
+ # Available to use for quota purposes for server-side applications. Can be any
624
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
625
+ # @param [Google::Apis::RequestOptions] options
626
+ # Request-specific options
627
+ #
628
+ # @yield [result, err] Result & error if block supplied
629
+ # @yieldparam result [Google::Apis::SecretmanagerV1::SecretVersion] parsed result object
630
+ # @yieldparam err [StandardError] error object if request failed
631
+ #
632
+ # @return [Google::Apis::SecretmanagerV1::SecretVersion]
633
+ #
634
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
635
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
636
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
637
+ def get_project_location_secret_version(name, fields: nil, quota_user: nil, options: nil, &block)
638
+ command = make_simple_command(:get, 'v1/{+name}', options)
639
+ command.response_representation = Google::Apis::SecretmanagerV1::SecretVersion::Representation
640
+ command.response_class = Google::Apis::SecretmanagerV1::SecretVersion
641
+ command.params['name'] = name unless name.nil?
642
+ command.query['fields'] = fields unless fields.nil?
643
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
644
+ execute_or_queue_command(command, &block)
645
+ end
646
+
647
+ # Lists SecretVersions. This call does not return secret data.
648
+ # @param [String] parent
649
+ # Required. The resource name of the Secret associated with the SecretVersions
650
+ # to list, in the format `projects/*/secrets/*` or `projects/*/locations/*/
651
+ # secrets/*`.
652
+ # @param [String] filter
653
+ # Optional. Filter string, adhering to the rules in [List-operation filtering](
654
+ # https://cloud.google.com/secret-manager/docs/filtering). List only secret
655
+ # versions matching the filter. If filter is empty, all secret versions are
656
+ # listed.
657
+ # @param [Fixnum] page_size
658
+ # Optional. The maximum number of results to be returned in a single page. If
659
+ # set to 0, the server decides the number of results to return. If the number is
660
+ # greater than 25000, it is capped at 25000.
661
+ # @param [String] page_token
662
+ # Optional. Pagination token, returned earlier via ListSecretVersionsResponse.
663
+ # next_page_token][].
664
+ # @param [String] fields
665
+ # Selector specifying which fields to include in a partial response.
666
+ # @param [String] quota_user
667
+ # Available to use for quota purposes for server-side applications. Can be any
668
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
669
+ # @param [Google::Apis::RequestOptions] options
670
+ # Request-specific options
671
+ #
672
+ # @yield [result, err] Result & error if block supplied
673
+ # @yieldparam result [Google::Apis::SecretmanagerV1::ListSecretVersionsResponse] parsed result object
674
+ # @yieldparam err [StandardError] error object if request failed
675
+ #
676
+ # @return [Google::Apis::SecretmanagerV1::ListSecretVersionsResponse]
677
+ #
678
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
679
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
680
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
681
+ def list_project_location_secret_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
682
+ command = make_simple_command(:get, 'v1/{+parent}/versions', options)
683
+ command.response_representation = Google::Apis::SecretmanagerV1::ListSecretVersionsResponse::Representation
684
+ command.response_class = Google::Apis::SecretmanagerV1::ListSecretVersionsResponse
685
+ command.params['parent'] = parent unless parent.nil?
686
+ command.query['filter'] = filter unless filter.nil?
687
+ command.query['pageSize'] = page_size unless page_size.nil?
688
+ command.query['pageToken'] = page_token unless page_token.nil?
689
+ command.query['fields'] = fields unless fields.nil?
690
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
691
+ execute_or_queue_command(command, &block)
692
+ end
693
+
694
+ # Creates a new SecretVersion containing secret data and attaches it to an
695
+ # existing Secret.
696
+ # @param [String] parent
697
+ # Required. The resource name of the Secret to associate with the SecretVersion
698
+ # in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.
133
699
  # @param [Google::Apis::SecretmanagerV1::AddSecretVersionRequest] add_secret_version_request_object
134
700
  # @param [String] fields
135
701
  # Selector specifying which fields to include in a partial response.
@@ -163,7 +729,7 @@ module Google
163
729
  # Creates a new Secret containing no SecretVersions.
164
730
  # @param [String] parent
165
731
  # Required. The resource name of the project to associate with the Secret, in
166
- # the format `projects/*`.
732
+ # the format `projects/*` or `projects/*/locations/*`.
167
733
  # @param [Google::Apis::SecretmanagerV1::Secret] secret_object
168
734
  # @param [String] secret_id
169
735
  # Required. This must be unique within the project. A secret ID is a string with
@@ -238,7 +804,7 @@ module Google
238
804
  # Gets metadata for a given Secret.
239
805
  # @param [String] name
240
806
  # Required. The resource name of the Secret, in the format `projects/*/secrets/*`
241
- # .
807
+ # or `projects/*/locations/*/secrets/*`.
242
808
  # @param [String] fields
243
809
  # Selector specifying which fields to include in a partial response.
244
810
  # @param [String] quota_user
@@ -314,7 +880,7 @@ module Google
314
880
  # Lists Secrets.
315
881
  # @param [String] parent
316
882
  # Required. The resource name of the project associated with the Secrets, in the
317
- # format `projects/*`.
883
+ # format `projects/*` or `projects/*/locations/*`
318
884
  # @param [String] filter
319
885
  # Optional. Filter string, adhering to the rules in [List-operation filtering](
320
886
  # https://cloud.google.com/secret-manager/docs/filtering). List only secrets
@@ -474,8 +1040,9 @@ module Google
474
1040
  # SecretVersion.
475
1041
  # @param [String] name
476
1042
  # Required. The resource name of the SecretVersion in the format `projects/*/
477
- # secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to
478
- # the most recently created SecretVersion.
1043
+ # secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `
1044
+ # projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/
1045
+ # versions/latest` is an alias to the most recently created SecretVersion.
479
1046
  # @param [String] fields
480
1047
  # Selector specifying which fields to include in a partial response.
481
1048
  # @param [String] quota_user
@@ -507,7 +1074,8 @@ module Google
507
1074
  # irrevocably destroys the secret data.
508
1075
  # @param [String] name
509
1076
  # Required. The resource name of the SecretVersion to destroy in the format `
510
- # projects/*/secrets/*/versions/*`.
1077
+ # projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/
1078
+ # *`.
511
1079
  # @param [Google::Apis::SecretmanagerV1::DestroySecretVersionRequest] destroy_secret_version_request_object
512
1080
  # @param [String] fields
513
1081
  # Selector specifying which fields to include in a partial response.
@@ -541,7 +1109,8 @@ module Google
541
1109
  # Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.
542
1110
  # @param [String] name
543
1111
  # Required. The resource name of the SecretVersion to disable in the format `
544
- # projects/*/secrets/*/versions/*`.
1112
+ # projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/
1113
+ # *`.
545
1114
  # @param [Google::Apis::SecretmanagerV1::DisableSecretVersionRequest] disable_secret_version_request_object
546
1115
  # @param [String] fields
547
1116
  # Selector specifying which fields to include in a partial response.
@@ -575,7 +1144,8 @@ module Google
575
1144
  # Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.
576
1145
  # @param [String] name
577
1146
  # Required. The resource name of the SecretVersion to enable in the format `
578
- # projects/*/secrets/*/versions/*`.
1147
+ # projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/
1148
+ # *`.
579
1149
  # @param [Google::Apis::SecretmanagerV1::EnableSecretVersionRequest] enable_secret_version_request_object
580
1150
  # @param [String] fields
581
1151
  # Selector specifying which fields to include in a partial response.
@@ -610,8 +1180,9 @@ module Google
610
1180
  # an alias to the most recently created SecretVersion.
611
1181
  # @param [String] name
612
1182
  # Required. The resource name of the SecretVersion in the format `projects/*/
613
- # secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to
614
- # the most recently created SecretVersion.
1183
+ # secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `
1184
+ # projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/
1185
+ # versions/latest` is an alias to the most recently created SecretVersion.
615
1186
  # @param [String] fields
616
1187
  # Selector specifying which fields to include in a partial response.
617
1188
  # @param [String] quota_user
@@ -642,7 +1213,8 @@ module Google
642
1213
  # Lists SecretVersions. This call does not return secret data.
643
1214
  # @param [String] parent
644
1215
  # Required. The resource name of the Secret associated with the SecretVersions
645
- # to list, in the format `projects/*/secrets/*`.
1216
+ # to list, in the format `projects/*/secrets/*` or `projects/*/locations/*/
1217
+ # secrets/*`.
646
1218
  # @param [String] filter
647
1219
  # Optional. Filter string, adhering to the rules in [List-operation filtering](
648
1220
  # https://cloud.google.com/secret-manager/docs/filtering). List only secret
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-secretmanager_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.38.0
4
+ version: 0.39.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: 2024-01-23 00:00:00.000000000 Z
11
+ date: 2024-02-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-secretmanager_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-secretmanager_v1/v0.38.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-secretmanager_v1/v0.39.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-secretmanager_v1
63
63
  post_install_message:
64
64
  rdoc_options: []