google-apis-cloudkms_v1 0.45.0 → 0.47.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 68667b0fc842cfd1f0d2d9514d4d5b9ee8c11695ae2846c3b65a676e03800e6c
4
- data.tar.gz: 9771689d32414c1fd19bfe33732f2e86cc5e32fa796bc0f2a2018540adb83107
3
+ metadata.gz: 22c870daebd56b0bfdb4a3f84e63839ccac49765f42e4a4694e767ec21f59226
4
+ data.tar.gz: 4b9b692401edf68a7d70da7806fe82a54f4c61b052e0fb5784b82a8177d689ba
5
5
  SHA512:
6
- metadata.gz: 3dd1595b7d5e5818317704bb3b8dc7b753d40cff59fe535318c30f6a170de83d840726dfe40c09f8060fff44b9f8c0037316e785c719696cb70f1993db243aed
7
- data.tar.gz: d152f860cf55f7e5e165ca1df5e0236da86a8591567e1aecf61b0f70b39b5cba5d129488aeb11af2e33189ed4a76f861e08db00a96c537b50afb7b3bae98a2fc
6
+ metadata.gz: 3a59a755ce4465624f6129c9fbb691f2114a38230692955c866dd82d383dd994e271a3681db42c6780ff545e0f0eaa89c317bc6c4e0b17625caababb1ea11a81
7
+ data.tar.gz: ad6257e0aa7d08c4c6d8e5461580599495eac8a8fdcbbe949f56e6b37f019c16d6080c322a03af177d85522d3482097cda625700b8efcac1f211e43b5f6b2dbd
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-cloudkms_v1
2
2
 
3
+ ### v0.47.0 (2024-05-05)
4
+
5
+ * Regenerated from discovery document revision 20240425
6
+
7
+ ### v0.46.0 (2024-03-31)
8
+
9
+ * Regenerated from discovery document revision 20240314
10
+
3
11
  ### v0.45.0 (2024-02-23)
4
12
 
5
13
  * Regenerated from discovery document revision 20240219
@@ -319,6 +319,38 @@ module Google
319
319
  end
320
320
  end
321
321
 
322
+ # Cloud KMS Autokey configuration for a folder.
323
+ class AutokeyConfig
324
+ include Google::Apis::Core::Hashable
325
+
326
+ # Optional. Name of the key project, e.g. `projects/`PROJECT_ID`` or `projects/`
327
+ # PROJECT_NUMBER``, where Cloud KMS Autokey will provision new CryptoKeys. On
328
+ # UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy`
329
+ # permission on this key project. Once configured, for Cloud KMS Autokey to
330
+ # function properly, this key project must have the Cloud KMS API activated and
331
+ # the Cloud KMS Service Agent for this key project must be granted the `cloudkms.
332
+ # admin` role (or pertinent permissions).
333
+ # Corresponds to the JSON property `keyProject`
334
+ # @return [String]
335
+ attr_accessor :key_project
336
+
337
+ # Identifier. Name of the AutokeyConfig resource, e.g. `folders/`FOLDER_NUMBER`/
338
+ # autokeyConfig`.
339
+ # Corresponds to the JSON property `name`
340
+ # @return [String]
341
+ attr_accessor :name
342
+
343
+ def initialize(**args)
344
+ update!(**args)
345
+ end
346
+
347
+ # Update properties of this object
348
+ def update!(**args)
349
+ @key_project = args[:key_project] if args.key?(:key_project)
350
+ @name = args[:name] if args.key?(:name)
351
+ end
352
+ end
353
+
322
354
  # Associates `members`, or principals, with a `role`.
323
355
  class Binding
324
356
  include Google::Apis::Core::Hashable
@@ -1494,6 +1526,43 @@ module Google
1494
1526
  end
1495
1527
  end
1496
1528
 
1529
+ # Resource-oriented representation of a request to Cloud KMS Autokey and the
1530
+ # resulting provisioning of a CryptoKey.
1531
+ class KeyHandle
1532
+ include Google::Apis::Core::Hashable
1533
+
1534
+ # Output only. Name of a CryptoKey that has been provisioned for Customer
1535
+ # Managed Encryption Key (CMEK) use in the KeyHandle's project and location for
1536
+ # the requested resource type.
1537
+ # Corresponds to the JSON property `kmsKey`
1538
+ # @return [String]
1539
+ attr_accessor :kms_key
1540
+
1541
+ # Output only. Identifier. Name of the [KeyHandle] resource, e.g. `projects/`
1542
+ # PROJECT_ID`/locations/`LOCATION`/keyHandles/`KEY_HANDLE_ID``.
1543
+ # Corresponds to the JSON property `name`
1544
+ # @return [String]
1545
+ attr_accessor :name
1546
+
1547
+ # Required. Indicates the resource type that the resulting CryptoKey is meant to
1548
+ # protect, e.g. ``SERVICE`.googleapis.com/`TYPE``. See documentation for
1549
+ # supported resource types.
1550
+ # Corresponds to the JSON property `resourceTypeSelector`
1551
+ # @return [String]
1552
+ attr_accessor :resource_type_selector
1553
+
1554
+ def initialize(**args)
1555
+ update!(**args)
1556
+ end
1557
+
1558
+ # Update properties of this object
1559
+ def update!(**args)
1560
+ @kms_key = args[:kms_key] if args.key?(:kms_key)
1561
+ @name = args[:name] if args.key?(:name)
1562
+ @resource_type_selector = args[:resource_type_selector] if args.key?(:resource_type_selector)
1563
+ end
1564
+ end
1565
+
1497
1566
  # Contains an HSM-generated attestation about a key operation. For more
1498
1567
  # information, see [Verifying attestations] (https://cloud.google.com/kms/docs/
1499
1568
  # attest-key).
@@ -1685,6 +1754,25 @@ module Google
1685
1754
  end
1686
1755
  end
1687
1756
 
1757
+ # Response message for Autokey.ListKeyHandles.
1758
+ class ListKeyHandlesResponse
1759
+ include Google::Apis::Core::Hashable
1760
+
1761
+ # Resulting KeyHandles.
1762
+ # Corresponds to the JSON property `keyHandles`
1763
+ # @return [Array<Google::Apis::CloudkmsV1::KeyHandle>]
1764
+ attr_accessor :key_handles
1765
+
1766
+ def initialize(**args)
1767
+ update!(**args)
1768
+ end
1769
+
1770
+ # Update properties of this object
1771
+ def update!(**args)
1772
+ @key_handles = args[:key_handles] if args.key?(:key_handles)
1773
+ end
1774
+ end
1775
+
1688
1776
  # Response message for KeyManagementService.ListKeyRings.
1689
1777
  class ListKeyRingsResponse
1690
1778
  include Google::Apis::Core::Hashable
@@ -2044,6 +2132,68 @@ module Google
2044
2132
  end
2045
2133
  end
2046
2134
 
2135
+ # This resource represents a long-running operation that is the result of a
2136
+ # network API call.
2137
+ class Operation
2138
+ include Google::Apis::Core::Hashable
2139
+
2140
+ # If the value is `false`, it means the operation is still in progress. If `true`
2141
+ # , the operation is completed, and either `error` or `response` is available.
2142
+ # Corresponds to the JSON property `done`
2143
+ # @return [Boolean]
2144
+ attr_accessor :done
2145
+ alias_method :done?, :done
2146
+
2147
+ # The `Status` type defines a logical error model that is suitable for different
2148
+ # programming environments, including REST APIs and RPC APIs. It is used by [
2149
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
2150
+ # data: error code, error message, and error details. You can find out more
2151
+ # about this error model and how to work with it in the [API Design Guide](https:
2152
+ # //cloud.google.com/apis/design/errors).
2153
+ # Corresponds to the JSON property `error`
2154
+ # @return [Google::Apis::CloudkmsV1::Status]
2155
+ attr_accessor :error
2156
+
2157
+ # Service-specific metadata associated with the operation. It typically contains
2158
+ # progress information and common metadata such as create time. Some services
2159
+ # might not provide such metadata. Any method that returns a long-running
2160
+ # operation should document the metadata type, if any.
2161
+ # Corresponds to the JSON property `metadata`
2162
+ # @return [Hash<String,Object>]
2163
+ attr_accessor :metadata
2164
+
2165
+ # The server-assigned name, which is only unique within the same service that
2166
+ # originally returns it. If you use the default HTTP mapping, the `name` should
2167
+ # be a resource name ending with `operations/`unique_id``.
2168
+ # Corresponds to the JSON property `name`
2169
+ # @return [String]
2170
+ attr_accessor :name
2171
+
2172
+ # The normal, successful response of the operation. If the original method
2173
+ # returns no data on success, such as `Delete`, the response is `google.protobuf.
2174
+ # Empty`. If the original method is standard `Get`/`Create`/`Update`, the
2175
+ # response should be the resource. For other methods, the response should have
2176
+ # the type `XxxResponse`, where `Xxx` is the original method name. For example,
2177
+ # if the original method name is `TakeSnapshot()`, the inferred response type is
2178
+ # `TakeSnapshotResponse`.
2179
+ # Corresponds to the JSON property `response`
2180
+ # @return [Hash<String,Object>]
2181
+ attr_accessor :response
2182
+
2183
+ def initialize(**args)
2184
+ update!(**args)
2185
+ end
2186
+
2187
+ # Update properties of this object
2188
+ def update!(**args)
2189
+ @done = args[:done] if args.key?(:done)
2190
+ @error = args[:error] if args.key?(:error)
2191
+ @metadata = args[:metadata] if args.key?(:metadata)
2192
+ @name = args[:name] if args.key?(:name)
2193
+ @response = args[:response] if args.key?(:response)
2194
+ end
2195
+ end
2196
+
2047
2197
  # An Identity and Access Management (IAM) policy, which specifies access
2048
2198
  # controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
2049
2199
  # A `binding` binds one or more `members`, or principals, to a single `role`.
@@ -2154,25 +2304,24 @@ module Google
2154
2304
  # @return [String]
2155
2305
  attr_accessor :name
2156
2306
 
2157
- # A public key encoded in PEM format, populated only when GetPublicKey returns
2158
- # one key. For more information, see the [RFC 7468](https://tools.ietf.org/html/
2159
- # rfc7468) sections for [General Considerations](https://tools.ietf.org/html/
2160
- # rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://
2161
- # tools.ietf.org/html/rfc7468#section-13).
2307
+ # The public key, encoded in PEM format. For more information, see the [RFC 7468]
2308
+ # (https://tools.ietf.org/html/rfc7468) sections for [General Considerations](
2309
+ # https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of
2310
+ # Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13).
2162
2311
  # Corresponds to the JSON property `pem`
2163
2312
  # @return [String]
2164
2313
  attr_accessor :pem
2165
2314
 
2166
- # Integrity verification field: A CRC32C checksum of the returned PublicKey.pem.
2167
- # It is only populated when GetPublicKey returns one key. An integrity check of
2168
- # PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.
2169
- # pem and comparing your results to this field. Discard the response in case of
2170
- # non-matching checksum values, and perform a limited number of retries. A
2171
- # persistent mismatch may indicate an issue in your computation of the CRC32C
2172
- # checksum. Note: This field is defined as int64 for reasons of compatibility
2173
- # across different languages. However, it is a non-negative integer, which will
2174
- # never exceed 2^32-1, and can be safely downconverted to uint32 in languages
2175
- # that support this type. NOTE: This field is in Beta.
2315
+ # Integrity verification field. A CRC32C checksum of the returned PublicKey.pem.
2316
+ # An integrity check of PublicKey.pem can be performed by computing the CRC32C
2317
+ # checksum of PublicKey.pem and comparing your results to this field. Discard
2318
+ # the response in case of non-matching checksum values, and perform a limited
2319
+ # number of retries. A persistent mismatch may indicate an issue in your
2320
+ # computation of the CRC32C checksum. Note: This field is defined as int64 for
2321
+ # reasons of compatibility across different languages. However, it is a non-
2322
+ # negative integer, which will never exceed 2^32-1, and can be safely
2323
+ # downconverted to uint32 in languages that support this type. NOTE: This field
2324
+ # is in Beta.
2176
2325
  # Corresponds to the JSON property `pemCrc32c`
2177
2326
  # @return [Fixnum]
2178
2327
  attr_accessor :pem_crc32c
@@ -2695,6 +2844,64 @@ module Google
2695
2844
  end
2696
2845
  end
2697
2846
 
2847
+ # Response message for ShowEffectiveAutokeyConfig.
2848
+ class ShowEffectiveAutokeyConfigResponse
2849
+ include Google::Apis::Core::Hashable
2850
+
2851
+ # Name of the key project configured in the resource project's folder ancestry.
2852
+ # Corresponds to the JSON property `keyProject`
2853
+ # @return [String]
2854
+ attr_accessor :key_project
2855
+
2856
+ def initialize(**args)
2857
+ update!(**args)
2858
+ end
2859
+
2860
+ # Update properties of this object
2861
+ def update!(**args)
2862
+ @key_project = args[:key_project] if args.key?(:key_project)
2863
+ end
2864
+ end
2865
+
2866
+ # The `Status` type defines a logical error model that is suitable for different
2867
+ # programming environments, including REST APIs and RPC APIs. It is used by [
2868
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
2869
+ # data: error code, error message, and error details. You can find out more
2870
+ # about this error model and how to work with it in the [API Design Guide](https:
2871
+ # //cloud.google.com/apis/design/errors).
2872
+ class Status
2873
+ include Google::Apis::Core::Hashable
2874
+
2875
+ # The status code, which should be an enum value of google.rpc.Code.
2876
+ # Corresponds to the JSON property `code`
2877
+ # @return [Fixnum]
2878
+ attr_accessor :code
2879
+
2880
+ # A list of messages that carry the error details. There is a common set of
2881
+ # message types for APIs to use.
2882
+ # Corresponds to the JSON property `details`
2883
+ # @return [Array<Hash<String,Object>>]
2884
+ attr_accessor :details
2885
+
2886
+ # A developer-facing error message, which should be in English. Any user-facing
2887
+ # error message should be localized and sent in the google.rpc.Status.details
2888
+ # field, or localized by the client.
2889
+ # Corresponds to the JSON property `message`
2890
+ # @return [String]
2891
+ attr_accessor :message
2892
+
2893
+ def initialize(**args)
2894
+ update!(**args)
2895
+ end
2896
+
2897
+ # Update properties of this object
2898
+ def update!(**args)
2899
+ @code = args[:code] if args.key?(:code)
2900
+ @details = args[:details] if args.key?(:details)
2901
+ @message = args[:message] if args.key?(:message)
2902
+ end
2903
+ end
2904
+
2698
2905
  # Request message for `TestIamPermissions` method.
2699
2906
  class TestIamPermissionsRequest
2700
2907
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module CloudkmsV1
18
18
  # Version of the google-apis-cloudkms_v1 gem
19
- GEM_VERSION = "0.45.0"
19
+ GEM_VERSION = "0.47.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.14.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240219"
25
+ REVISION = "20240425"
26
26
  end
27
27
  end
28
28
  end
@@ -58,6 +58,12 @@ module Google
58
58
  include Google::Apis::Core::JsonObjectSupport
59
59
  end
60
60
 
61
+ class AutokeyConfig
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
61
67
  class Binding
62
68
  class Representation < Google::Apis::Core::JsonRepresentation; end
63
69
 
@@ -178,6 +184,12 @@ module Google
178
184
  include Google::Apis::Core::JsonObjectSupport
179
185
  end
180
186
 
187
+ class KeyHandle
188
+ class Representation < Google::Apis::Core::JsonRepresentation; end
189
+
190
+ include Google::Apis::Core::JsonObjectSupport
191
+ end
192
+
181
193
  class KeyOperationAttestation
182
194
  class Representation < Google::Apis::Core::JsonRepresentation; end
183
195
 
@@ -214,6 +226,12 @@ module Google
214
226
  include Google::Apis::Core::JsonObjectSupport
215
227
  end
216
228
 
229
+ class ListKeyHandlesResponse
230
+ class Representation < Google::Apis::Core::JsonRepresentation; end
231
+
232
+ include Google::Apis::Core::JsonObjectSupport
233
+ end
234
+
217
235
  class ListKeyRingsResponse
218
236
  class Representation < Google::Apis::Core::JsonRepresentation; end
219
237
 
@@ -262,6 +280,12 @@ module Google
262
280
  include Google::Apis::Core::JsonObjectSupport
263
281
  end
264
282
 
283
+ class Operation
284
+ class Representation < Google::Apis::Core::JsonRepresentation; end
285
+
286
+ include Google::Apis::Core::JsonObjectSupport
287
+ end
288
+
265
289
  class Policy
266
290
  class Representation < Google::Apis::Core::JsonRepresentation; end
267
291
 
@@ -316,6 +340,18 @@ module Google
316
340
  include Google::Apis::Core::JsonObjectSupport
317
341
  end
318
342
 
343
+ class ShowEffectiveAutokeyConfigResponse
344
+ class Representation < Google::Apis::Core::JsonRepresentation; end
345
+
346
+ include Google::Apis::Core::JsonObjectSupport
347
+ end
348
+
349
+ class Status
350
+ class Representation < Google::Apis::Core::JsonRepresentation; end
351
+
352
+ include Google::Apis::Core::JsonObjectSupport
353
+ end
354
+
319
355
  class TestIamPermissionsRequest
320
356
  class Representation < Google::Apis::Core::JsonRepresentation; end
321
357
 
@@ -404,6 +440,14 @@ module Google
404
440
  end
405
441
  end
406
442
 
443
+ class AutokeyConfig
444
+ # @private
445
+ class Representation < Google::Apis::Core::JsonRepresentation
446
+ property :key_project, as: 'keyProject'
447
+ property :name, as: 'name'
448
+ end
449
+ end
450
+
407
451
  class Binding
408
452
  # @private
409
453
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -630,6 +674,15 @@ module Google
630
674
  end
631
675
  end
632
676
 
677
+ class KeyHandle
678
+ # @private
679
+ class Representation < Google::Apis::Core::JsonRepresentation
680
+ property :kms_key, as: 'kmsKey'
681
+ property :name, as: 'name'
682
+ property :resource_type_selector, as: 'resourceTypeSelector'
683
+ end
684
+ end
685
+
633
686
  class KeyOperationAttestation
634
687
  # @private
635
688
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -688,6 +741,14 @@ module Google
688
741
  end
689
742
  end
690
743
 
744
+ class ListKeyHandlesResponse
745
+ # @private
746
+ class Representation < Google::Apis::Core::JsonRepresentation
747
+ collection :key_handles, as: 'keyHandles', class: Google::Apis::CloudkmsV1::KeyHandle, decorator: Google::Apis::CloudkmsV1::KeyHandle::Representation
748
+
749
+ end
750
+ end
751
+
691
752
  class ListKeyRingsResponse
692
753
  # @private
693
754
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -767,6 +828,18 @@ module Google
767
828
  end
768
829
  end
769
830
 
831
+ class Operation
832
+ # @private
833
+ class Representation < Google::Apis::Core::JsonRepresentation
834
+ property :done, as: 'done'
835
+ property :error, as: 'error', class: Google::Apis::CloudkmsV1::Status, decorator: Google::Apis::CloudkmsV1::Status::Representation
836
+
837
+ hash :metadata, as: 'metadata'
838
+ property :name, as: 'name'
839
+ hash :response, as: 'response'
840
+ end
841
+ end
842
+
770
843
  class Policy
771
844
  # @private
772
845
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -869,6 +942,22 @@ module Google
869
942
  end
870
943
  end
871
944
 
945
+ class ShowEffectiveAutokeyConfigResponse
946
+ # @private
947
+ class Representation < Google::Apis::Core::JsonRepresentation
948
+ property :key_project, as: 'keyProject'
949
+ end
950
+ end
951
+
952
+ class Status
953
+ # @private
954
+ class Representation < Google::Apis::Core::JsonRepresentation
955
+ property :code, as: 'code'
956
+ collection :details, as: 'details'
957
+ property :message, as: 'message'
958
+ end
959
+ end
960
+
872
961
  class TestIamPermissionsRequest
873
962
  # @private
874
963
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -52,6 +52,109 @@ module Google
52
52
  @batch_path = 'batch'
53
53
  end
54
54
 
55
+ # Returns the AutokeyConfig for a folder.
56
+ # @param [String] name
57
+ # Required. Name of the AutokeyConfig resource, e.g. `folders/`FOLDER_NUMBER`/
58
+ # autokeyConfig`.
59
+ # @param [String] fields
60
+ # Selector specifying which fields to include in a partial response.
61
+ # @param [String] quota_user
62
+ # Available to use for quota purposes for server-side applications. Can be any
63
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
64
+ # @param [Google::Apis::RequestOptions] options
65
+ # Request-specific options
66
+ #
67
+ # @yield [result, err] Result & error if block supplied
68
+ # @yieldparam result [Google::Apis::CloudkmsV1::AutokeyConfig] parsed result object
69
+ # @yieldparam err [StandardError] error object if request failed
70
+ #
71
+ # @return [Google::Apis::CloudkmsV1::AutokeyConfig]
72
+ #
73
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
74
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
75
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
76
+ def get_folder_autokey_config(name, fields: nil, quota_user: nil, options: nil, &block)
77
+ command = make_simple_command(:get, 'v1/{+name}', options)
78
+ command.response_representation = Google::Apis::CloudkmsV1::AutokeyConfig::Representation
79
+ command.response_class = Google::Apis::CloudkmsV1::AutokeyConfig
80
+ command.params['name'] = name unless name.nil?
81
+ command.query['fields'] = fields unless fields.nil?
82
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
83
+ execute_or_queue_command(command, &block)
84
+ end
85
+
86
+ # Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.
87
+ # autokeyConfigs.update` permission on the parent folder and `cloudkms.
88
+ # cryptoKeys.setIamPolicy` permission on the provided key project. An empty key
89
+ # project may be provided to clear the configuration.
90
+ # @param [String] name
91
+ # Identifier. Name of the AutokeyConfig resource, e.g. `folders/`FOLDER_NUMBER`/
92
+ # autokeyConfig`.
93
+ # @param [Google::Apis::CloudkmsV1::AutokeyConfig] autokey_config_object
94
+ # @param [String] update_mask
95
+ # Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.
96
+ # @param [String] fields
97
+ # Selector specifying which fields to include in a partial response.
98
+ # @param [String] quota_user
99
+ # Available to use for quota purposes for server-side applications. Can be any
100
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
101
+ # @param [Google::Apis::RequestOptions] options
102
+ # Request-specific options
103
+ #
104
+ # @yield [result, err] Result & error if block supplied
105
+ # @yieldparam result [Google::Apis::CloudkmsV1::AutokeyConfig] parsed result object
106
+ # @yieldparam err [StandardError] error object if request failed
107
+ #
108
+ # @return [Google::Apis::CloudkmsV1::AutokeyConfig]
109
+ #
110
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
111
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
112
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
113
+ def update_folder_autokey_config(name, autokey_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
114
+ command = make_simple_command(:patch, 'v1/{+name}', options)
115
+ command.request_representation = Google::Apis::CloudkmsV1::AutokeyConfig::Representation
116
+ command.request_object = autokey_config_object
117
+ command.response_representation = Google::Apis::CloudkmsV1::AutokeyConfig::Representation
118
+ command.response_class = Google::Apis::CloudkmsV1::AutokeyConfig
119
+ command.params['name'] = name unless name.nil?
120
+ command.query['updateMask'] = update_mask unless update_mask.nil?
121
+ command.query['fields'] = fields unless fields.nil?
122
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
123
+ execute_or_queue_command(command, &block)
124
+ end
125
+
126
+ # Returns the effective Cloud KMS Autokey configuration for a given project.
127
+ # @param [String] parent
128
+ # Required. Name of the resource project to the show effective Cloud KMS Autokey
129
+ # configuration for. This may be helpful for interrogating the effect of nested
130
+ # folder configurations on a given resource project.
131
+ # @param [String] fields
132
+ # Selector specifying which fields to include in a partial response.
133
+ # @param [String] quota_user
134
+ # Available to use for quota purposes for server-side applications. Can be any
135
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
136
+ # @param [Google::Apis::RequestOptions] options
137
+ # Request-specific options
138
+ #
139
+ # @yield [result, err] Result & error if block supplied
140
+ # @yieldparam result [Google::Apis::CloudkmsV1::ShowEffectiveAutokeyConfigResponse] parsed result object
141
+ # @yieldparam err [StandardError] error object if request failed
142
+ #
143
+ # @return [Google::Apis::CloudkmsV1::ShowEffectiveAutokeyConfigResponse]
144
+ #
145
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
146
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
147
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
148
+ def show_project_effective_autokey_config(parent, fields: nil, quota_user: nil, options: nil, &block)
149
+ command = make_simple_command(:get, 'v1/{+parent}:showEffectiveAutokeyConfig', options)
150
+ command.response_representation = Google::Apis::CloudkmsV1::ShowEffectiveAutokeyConfigResponse::Representation
151
+ command.response_class = Google::Apis::CloudkmsV1::ShowEffectiveAutokeyConfigResponse
152
+ command.params['parent'] = parent unless parent.nil?
153
+ command.query['fields'] = fields unless fields.nil?
154
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
155
+ execute_or_queue_command(command, &block)
156
+ end
157
+
55
158
  # Generate random bytes using the Cloud KMS randomness source in the provided
56
159
  # location.
57
160
  # @param [String] location
@@ -660,6 +763,113 @@ module Google
660
763
  execute_or_queue_command(command, &block)
661
764
  end
662
765
 
766
+ # Creates a new KeyHandle, triggering the provisioning of a new CryptoKey for
767
+ # CMEK use with the given resource type in the configured key project and the
768
+ # same location. GetOperation should be used to resolve the resulting long-
769
+ # running operation and get the resulting KeyHandle and CryptoKey.
770
+ # @param [String] parent
771
+ # Required. Name of the resource project and location to create the KeyHandle in,
772
+ # e.g. `projects/`PROJECT_ID`/locations/`LOCATION``.
773
+ # @param [Google::Apis::CloudkmsV1::KeyHandle] key_handle_object
774
+ # @param [String] key_handle_id
775
+ # Optional. Id of the KeyHandle. Must be unique to the resource project and
776
+ # location. If not provided by the caller, a new UUID is used.
777
+ # @param [String] fields
778
+ # Selector specifying which fields to include in a partial response.
779
+ # @param [String] quota_user
780
+ # Available to use for quota purposes for server-side applications. Can be any
781
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
782
+ # @param [Google::Apis::RequestOptions] options
783
+ # Request-specific options
784
+ #
785
+ # @yield [result, err] Result & error if block supplied
786
+ # @yieldparam result [Google::Apis::CloudkmsV1::Operation] parsed result object
787
+ # @yieldparam err [StandardError] error object if request failed
788
+ #
789
+ # @return [Google::Apis::CloudkmsV1::Operation]
790
+ #
791
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
792
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
793
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
794
+ def create_project_location_key_handle(parent, key_handle_object = nil, key_handle_id: nil, fields: nil, quota_user: nil, options: nil, &block)
795
+ command = make_simple_command(:post, 'v1/{+parent}/keyHandles', options)
796
+ command.request_representation = Google::Apis::CloudkmsV1::KeyHandle::Representation
797
+ command.request_object = key_handle_object
798
+ command.response_representation = Google::Apis::CloudkmsV1::Operation::Representation
799
+ command.response_class = Google::Apis::CloudkmsV1::Operation
800
+ command.params['parent'] = parent unless parent.nil?
801
+ command.query['keyHandleId'] = key_handle_id unless key_handle_id.nil?
802
+ command.query['fields'] = fields unless fields.nil?
803
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
804
+ execute_or_queue_command(command, &block)
805
+ end
806
+
807
+ # Returns the KeyHandle.
808
+ # @param [String] name
809
+ # Required. Name of the KeyHandle resource, e.g. `projects/`PROJECT_ID`/
810
+ # locations/`LOCATION`/keyHandles/`KEY_HANDLE_ID``.
811
+ # @param [String] fields
812
+ # Selector specifying which fields to include in a partial response.
813
+ # @param [String] quota_user
814
+ # Available to use for quota purposes for server-side applications. Can be any
815
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
816
+ # @param [Google::Apis::RequestOptions] options
817
+ # Request-specific options
818
+ #
819
+ # @yield [result, err] Result & error if block supplied
820
+ # @yieldparam result [Google::Apis::CloudkmsV1::KeyHandle] parsed result object
821
+ # @yieldparam err [StandardError] error object if request failed
822
+ #
823
+ # @return [Google::Apis::CloudkmsV1::KeyHandle]
824
+ #
825
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
826
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
827
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
828
+ def get_project_location_key_handle(name, fields: nil, quota_user: nil, options: nil, &block)
829
+ command = make_simple_command(:get, 'v1/{+name}', options)
830
+ command.response_representation = Google::Apis::CloudkmsV1::KeyHandle::Representation
831
+ command.response_class = Google::Apis::CloudkmsV1::KeyHandle
832
+ command.params['name'] = name unless name.nil?
833
+ command.query['fields'] = fields unless fields.nil?
834
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
835
+ execute_or_queue_command(command, &block)
836
+ end
837
+
838
+ # Lists KeyHandles.
839
+ # @param [String] parent
840
+ # Required. Name of the resource project and location from which to list
841
+ # KeyHandles, e.g. `projects/`PROJECT_ID`/locations/`LOCATION``.
842
+ # @param [String] filter
843
+ # Optional. Filter to apply when listing KeyHandles, e.g. `
844
+ # resource_type_selector="`SERVICE`.googleapis.com/`TYPE`"`.
845
+ # @param [String] fields
846
+ # Selector specifying which fields to include in a partial response.
847
+ # @param [String] quota_user
848
+ # Available to use for quota purposes for server-side applications. Can be any
849
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
850
+ # @param [Google::Apis::RequestOptions] options
851
+ # Request-specific options
852
+ #
853
+ # @yield [result, err] Result & error if block supplied
854
+ # @yieldparam result [Google::Apis::CloudkmsV1::ListKeyHandlesResponse] parsed result object
855
+ # @yieldparam err [StandardError] error object if request failed
856
+ #
857
+ # @return [Google::Apis::CloudkmsV1::ListKeyHandlesResponse]
858
+ #
859
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
860
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
861
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
862
+ def list_project_location_key_handles(parent, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
863
+ command = make_simple_command(:get, 'v1/{+parent}/keyHandles', options)
864
+ command.response_representation = Google::Apis::CloudkmsV1::ListKeyHandlesResponse::Representation
865
+ command.response_class = Google::Apis::CloudkmsV1::ListKeyHandlesResponse
866
+ command.params['parent'] = parent unless parent.nil?
867
+ command.query['filter'] = filter unless filter.nil?
868
+ command.query['fields'] = fields unless fields.nil?
869
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
870
+ execute_or_queue_command(command, &block)
871
+ end
872
+
663
873
  # Create a new KeyRing in a given Project and Location.
664
874
  # @param [String] parent
665
875
  # Required. The resource name of the location associated with the KeyRings, in
@@ -2039,6 +2249,37 @@ module Google
2039
2249
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2040
2250
  execute_or_queue_command(command, &block)
2041
2251
  end
2252
+
2253
+ # Gets the latest state of a long-running operation. Clients can use this method
2254
+ # to poll the operation result at intervals as recommended by the API service.
2255
+ # @param [String] name
2256
+ # The name of the operation resource.
2257
+ # @param [String] fields
2258
+ # Selector specifying which fields to include in a partial response.
2259
+ # @param [String] quota_user
2260
+ # Available to use for quota purposes for server-side applications. Can be any
2261
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2262
+ # @param [Google::Apis::RequestOptions] options
2263
+ # Request-specific options
2264
+ #
2265
+ # @yield [result, err] Result & error if block supplied
2266
+ # @yieldparam result [Google::Apis::CloudkmsV1::Operation] parsed result object
2267
+ # @yieldparam err [StandardError] error object if request failed
2268
+ #
2269
+ # @return [Google::Apis::CloudkmsV1::Operation]
2270
+ #
2271
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2272
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2273
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2274
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
2275
+ command = make_simple_command(:get, 'v1/{+name}', options)
2276
+ command.response_representation = Google::Apis::CloudkmsV1::Operation::Representation
2277
+ command.response_class = Google::Apis::CloudkmsV1::Operation
2278
+ command.params['name'] = name unless name.nil?
2279
+ command.query['fields'] = fields unless fields.nil?
2280
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2281
+ execute_or_queue_command(command, &block)
2282
+ end
2042
2283
 
2043
2284
  protected
2044
2285
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-cloudkms_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.45.0
4
+ version: 0.47.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-02-25 00:00:00.000000000 Z
11
+ date: 2024-05-05 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-cloudkms_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-cloudkms_v1/v0.45.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudkms_v1/v0.47.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudkms_v1
63
63
  post_install_message:
64
64
  rdoc_options: []