google-apis-cloudkms_v1 0.36.0 → 0.38.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: b5f4246318ae68edf6b31f0139bf7e8ce41a1d01c10ce4c0f258bcd46503f466
4
- data.tar.gz: 50f6f8261843f08d1bd279e371a4d82015e7cb2c842b2e2629a03220549d133d
3
+ metadata.gz: ab0f3194236e78fd812a46360b034e9484e6b750060852f7aadcdcfa3468523c
4
+ data.tar.gz: '058c24a273cc04b670efedf25c91d8973905b51693181dbc3bac36d1d611c765'
5
5
  SHA512:
6
- metadata.gz: 7e7d5fc1a37c068e1f624e539633dbbf9434a53a36e66a944d27338207de065b20b219465a913cb4feb973db54a8794a5c9885d11a6ac9b37061e85600410311
7
- data.tar.gz: 74c4c39a8393a6f7a1c99a598157dca0a870baa4156a5bd0043ffcfa728e84ca58ba08950404646757c967311d8f6f0e1435563cdf6fff6410a5667566dd8c6f
6
+ metadata.gz: 97a6949b9de768a466fb09dc13b1ba9568c40f56270865099094a0b0bbed14412a2f53ec0a5f5b29518b7d8e9875f3fff8d6169fc47d8140bfeccd14ea8305ba
7
+ data.tar.gz: fc076620a6717f5836badcafd3fca821eb82320489445c212253883594f91212471d63570f3541a80e3d79590715f60a206ac4e27f6461e7ba6d6d1ab7ed7824
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-cloudkms_v1
2
2
 
3
+ ### v0.38.0 (2023-04-16)
4
+
5
+ * Regenerated from discovery document revision 20230407
6
+
7
+ ### v0.37.0 (2023-03-12)
8
+
9
+ * Regenerated from discovery document revision 20230307
10
+
3
11
  ### v0.36.0 (2023-02-19)
4
12
 
5
13
  * Regenerated using generator version 0.12.0
@@ -649,6 +649,12 @@ module Google
649
649
  # @return [String]
650
650
  attr_accessor :destroy_time
651
651
 
652
+ # Output only. The root cause of the most recent external destruction failure.
653
+ # Only present if state is EXTERNAL_DESTRUCTION_FAILED.
654
+ # Corresponds to the JSON property `externalDestructionFailureReason`
655
+ # @return [String]
656
+ attr_accessor :external_destruction_failure_reason
657
+
652
658
  # ExternalProtectionLevelOptions stores a group of additional fields for
653
659
  # configuring a CryptoKeyVersion that are specific to the EXTERNAL protection
654
660
  # level and EXTERNAL_VPC protection levels.
@@ -661,6 +667,12 @@ module Google
661
667
  # @return [String]
662
668
  attr_accessor :generate_time
663
669
 
670
+ # Output only. The root cause of the most recent generation failure. Only
671
+ # present if state is GENERATION_FAILED.
672
+ # Corresponds to the JSON property `generationFailureReason`
673
+ # @return [String]
674
+ attr_accessor :generation_failure_reason
675
+
664
676
  # Output only. The root cause of the most recent import failure. Only present if
665
677
  # state is IMPORT_FAILED.
666
678
  # Corresponds to the JSON property `importFailureReason`
@@ -715,8 +727,10 @@ module Google
715
727
  @create_time = args[:create_time] if args.key?(:create_time)
716
728
  @destroy_event_time = args[:destroy_event_time] if args.key?(:destroy_event_time)
717
729
  @destroy_time = args[:destroy_time] if args.key?(:destroy_time)
730
+ @external_destruction_failure_reason = args[:external_destruction_failure_reason] if args.key?(:external_destruction_failure_reason)
718
731
  @external_protection_level_options = args[:external_protection_level_options] if args.key?(:external_protection_level_options)
719
732
  @generate_time = args[:generate_time] if args.key?(:generate_time)
733
+ @generation_failure_reason = args[:generation_failure_reason] if args.key?(:generation_failure_reason)
720
734
  @import_failure_reason = args[:import_failure_reason] if args.key?(:import_failure_reason)
721
735
  @import_job = args[:import_job] if args.key?(:import_job)
722
736
  @import_time = args[:import_time] if args.key?(:import_time)
@@ -915,6 +929,35 @@ module Google
915
929
  end
916
930
  end
917
931
 
932
+ # An EkmConfig is a singleton resource that represents configuration parameters
933
+ # that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of
934
+ # EXTERNAL_VPC in a given project and location.
935
+ class EkmConfig
936
+ include Google::Apis::Core::Hashable
937
+
938
+ # Optional. Resource name of the default EkmConnection. Setting this field to
939
+ # the empty string removes the default.
940
+ # Corresponds to the JSON property `defaultEkmConnection`
941
+ # @return [String]
942
+ attr_accessor :default_ekm_connection
943
+
944
+ # Output only. The resource name for the EkmConfig in the format `projects/*/
945
+ # locations/*/ekmConfig`.
946
+ # Corresponds to the JSON property `name`
947
+ # @return [String]
948
+ attr_accessor :name
949
+
950
+ def initialize(**args)
951
+ update!(**args)
952
+ end
953
+
954
+ # Update properties of this object
955
+ def update!(**args)
956
+ @default_ekm_connection = args[:default_ekm_connection] if args.key?(:default_ekm_connection)
957
+ @name = args[:name] if args.key?(:name)
958
+ end
959
+ end
960
+
918
961
  # An EkmConnection represents an individual EKM connection. It can be used for
919
962
  # creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of
920
963
  # EXTERNAL_VPC, as well as performing cryptographic operations using keys
@@ -927,11 +970,23 @@ module Google
927
970
  # @return [String]
928
971
  attr_accessor :create_time
929
972
 
973
+ # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to.
974
+ # Note: This field is required if KeyManagementMode is CLOUD_KMS.
975
+ # Corresponds to the JSON property `cryptoSpacePath`
976
+ # @return [String]
977
+ attr_accessor :crypto_space_path
978
+
930
979
  # Optional. Etag of the currently stored EkmConnection.
931
980
  # Corresponds to the JSON property `etag`
932
981
  # @return [String]
933
982
  attr_accessor :etag
934
983
 
984
+ # Optional. Describes who can perform control plane operations on the EKM. If
985
+ # unset, this defaults to MANUAL.
986
+ # Corresponds to the JSON property `keyManagementMode`
987
+ # @return [String]
988
+ attr_accessor :key_management_mode
989
+
935
990
  # Output only. The resource name for the EkmConnection in the format `projects/*/
936
991
  # locations/*/ekmConnections/*`.
937
992
  # Corresponds to the JSON property `name`
@@ -952,7 +1007,9 @@ module Google
952
1007
  # Update properties of this object
953
1008
  def update!(**args)
954
1009
  @create_time = args[:create_time] if args.key?(:create_time)
1010
+ @crypto_space_path = args[:crypto_space_path] if args.key?(:crypto_space_path)
955
1011
  @etag = args[:etag] if args.key?(:etag)
1012
+ @key_management_mode = args[:key_management_mode] if args.key?(:key_management_mode)
956
1013
  @name = args[:name] if args.key?(:name)
957
1014
  @service_resolvers = args[:service_resolvers] if args.key?(:service_resolvers)
958
1015
  end
@@ -2283,6 +2340,19 @@ module Google
2283
2340
  end
2284
2341
  end
2285
2342
 
2343
+ # Response message for EkmService.VerifyConnectivity.
2344
+ class VerifyConnectivityResponse
2345
+ include Google::Apis::Core::Hashable
2346
+
2347
+ def initialize(**args)
2348
+ update!(**args)
2349
+ end
2350
+
2351
+ # Update properties of this object
2352
+ def update!(**args)
2353
+ end
2354
+ end
2355
+
2286
2356
  # The public key component of the wrapping key. For details of the type of key
2287
2357
  # this public key corresponds to, see the ImportMethod.
2288
2358
  class WrappingPublicKey
@@ -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.36.0"
19
+ GEM_VERSION = "0.38.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230127"
25
+ REVISION = "20230407"
26
26
  end
27
27
  end
28
28
  end
@@ -118,6 +118,12 @@ module Google
118
118
  include Google::Apis::Core::JsonObjectSupport
119
119
  end
120
120
 
121
+ class EkmConfig
122
+ class Representation < Google::Apis::Core::JsonRepresentation; end
123
+
124
+ include Google::Apis::Core::JsonObjectSupport
125
+ end
126
+
121
127
  class EkmConnection
122
128
  class Representation < Google::Apis::Core::JsonRepresentation; end
123
129
 
@@ -304,6 +310,12 @@ module Google
304
310
  include Google::Apis::Core::JsonObjectSupport
305
311
  end
306
312
 
313
+ class VerifyConnectivityResponse
314
+ class Representation < Google::Apis::Core::JsonRepresentation; end
315
+
316
+ include Google::Apis::Core::JsonObjectSupport
317
+ end
318
+
307
319
  class WrappingPublicKey
308
320
  class Representation < Google::Apis::Core::JsonRepresentation; end
309
321
 
@@ -430,9 +442,11 @@ module Google
430
442
  property :create_time, as: 'createTime'
431
443
  property :destroy_event_time, as: 'destroyEventTime'
432
444
  property :destroy_time, as: 'destroyTime'
445
+ property :external_destruction_failure_reason, as: 'externalDestructionFailureReason'
433
446
  property :external_protection_level_options, as: 'externalProtectionLevelOptions', class: Google::Apis::CloudkmsV1::ExternalProtectionLevelOptions, decorator: Google::Apis::CloudkmsV1::ExternalProtectionLevelOptions::Representation
434
447
 
435
448
  property :generate_time, as: 'generateTime'
449
+ property :generation_failure_reason, as: 'generationFailureReason'
436
450
  property :import_failure_reason, as: 'importFailureReason'
437
451
  property :import_job, as: 'importJob'
438
452
  property :import_time, as: 'importTime'
@@ -486,11 +500,21 @@ module Google
486
500
  end
487
501
  end
488
502
 
503
+ class EkmConfig
504
+ # @private
505
+ class Representation < Google::Apis::Core::JsonRepresentation
506
+ property :default_ekm_connection, as: 'defaultEkmConnection'
507
+ property :name, as: 'name'
508
+ end
509
+ end
510
+
489
511
  class EkmConnection
490
512
  # @private
491
513
  class Representation < Google::Apis::Core::JsonRepresentation
492
514
  property :create_time, as: 'createTime'
515
+ property :crypto_space_path, as: 'cryptoSpacePath'
493
516
  property :etag, as: 'etag'
517
+ property :key_management_mode, as: 'keyManagementMode'
494
518
  property :name, as: 'name'
495
519
  collection :service_resolvers, as: 'serviceResolvers', class: Google::Apis::CloudkmsV1::ServiceResolver, decorator: Google::Apis::CloudkmsV1::ServiceResolver::Representation
496
520
 
@@ -789,6 +813,12 @@ module Google
789
813
  end
790
814
  end
791
815
 
816
+ class VerifyConnectivityResponse
817
+ # @private
818
+ class Representation < Google::Apis::Core::JsonRepresentation
819
+ end
820
+ end
821
+
792
822
  class WrappingPublicKey
793
823
  # @private
794
824
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -115,6 +115,36 @@ module Google
115
115
  execute_or_queue_command(command, &block)
116
116
  end
117
117
 
118
+ # Returns the EkmConfig singleton resource for a given project and location.
119
+ # @param [String] name
120
+ # Required. The name of the EkmConfig to get.
121
+ # @param [String] fields
122
+ # Selector specifying which fields to include in a partial response.
123
+ # @param [String] quota_user
124
+ # Available to use for quota purposes for server-side applications. Can be any
125
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
126
+ # @param [Google::Apis::RequestOptions] options
127
+ # Request-specific options
128
+ #
129
+ # @yield [result, err] Result & error if block supplied
130
+ # @yieldparam result [Google::Apis::CloudkmsV1::EkmConfig] parsed result object
131
+ # @yieldparam err [StandardError] error object if request failed
132
+ #
133
+ # @return [Google::Apis::CloudkmsV1::EkmConfig]
134
+ #
135
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
136
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
137
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
138
+ def get_project_location_ekm_config(name, fields: nil, quota_user: nil, options: nil, &block)
139
+ command = make_simple_command(:get, 'v1/{+name}', options)
140
+ command.response_representation = Google::Apis::CloudkmsV1::EkmConfig::Representation
141
+ command.response_class = Google::Apis::CloudkmsV1::EkmConfig
142
+ command.params['name'] = name unless name.nil?
143
+ command.query['fields'] = fields unless fields.nil?
144
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
145
+ execute_or_queue_command(command, &block)
146
+ end
147
+
118
148
  # Lists information about the supported locations for this service.
119
149
  # @param [String] name
120
150
  # The resource that owns the locations collection, if applicable.
@@ -158,6 +188,43 @@ module Google
158
188
  execute_or_queue_command(command, &block)
159
189
  end
160
190
 
191
+ # Updates the EkmConfig singleton resource for a given project and location.
192
+ # @param [String] name
193
+ # Output only. The resource name for the EkmConfig in the format `projects/*/
194
+ # locations/*/ekmConfig`.
195
+ # @param [Google::Apis::CloudkmsV1::EkmConfig] ekm_config_object
196
+ # @param [String] update_mask
197
+ # Required. List of fields to be updated in this request.
198
+ # @param [String] fields
199
+ # Selector specifying which fields to include in a partial response.
200
+ # @param [String] quota_user
201
+ # Available to use for quota purposes for server-side applications. Can be any
202
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
203
+ # @param [Google::Apis::RequestOptions] options
204
+ # Request-specific options
205
+ #
206
+ # @yield [result, err] Result & error if block supplied
207
+ # @yieldparam result [Google::Apis::CloudkmsV1::EkmConfig] parsed result object
208
+ # @yieldparam err [StandardError] error object if request failed
209
+ #
210
+ # @return [Google::Apis::CloudkmsV1::EkmConfig]
211
+ #
212
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
213
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
214
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
215
+ def update_project_location_ekm_config(name, ekm_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
216
+ command = make_simple_command(:patch, 'v1/{+name}', options)
217
+ command.request_representation = Google::Apis::CloudkmsV1::EkmConfig::Representation
218
+ command.request_object = ekm_config_object
219
+ command.response_representation = Google::Apis::CloudkmsV1::EkmConfig::Representation
220
+ command.response_class = Google::Apis::CloudkmsV1::EkmConfig
221
+ command.params['name'] = name unless name.nil?
222
+ command.query['updateMask'] = update_mask unless update_mask.nil?
223
+ command.query['fields'] = fields unless fields.nil?
224
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
225
+ execute_or_queue_command(command, &block)
226
+ end
227
+
161
228
  # Gets the access control policy for a resource. Returns an empty policy if the
162
229
  # resource exists and does not have a policy set.
163
230
  # @param [String] resource
@@ -557,6 +624,40 @@ module Google
557
624
  execute_or_queue_command(command, &block)
558
625
  end
559
626
 
627
+ # Verifies that Cloud KMS can successfully connect to the external key manager
628
+ # specified by an EkmConnection. If there is an error connecting to the EKM,
629
+ # this method returns a FAILED_PRECONDITION status containing structured
630
+ # information as described at https://cloud.google.com/kms/docs/reference/
631
+ # ekm_errors.
632
+ # @param [String] name
633
+ # Required. The name of the EkmConnection to verify.
634
+ # @param [String] fields
635
+ # Selector specifying which fields to include in a partial response.
636
+ # @param [String] quota_user
637
+ # Available to use for quota purposes for server-side applications. Can be any
638
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
639
+ # @param [Google::Apis::RequestOptions] options
640
+ # Request-specific options
641
+ #
642
+ # @yield [result, err] Result & error if block supplied
643
+ # @yieldparam result [Google::Apis::CloudkmsV1::VerifyConnectivityResponse] parsed result object
644
+ # @yieldparam err [StandardError] error object if request failed
645
+ #
646
+ # @return [Google::Apis::CloudkmsV1::VerifyConnectivityResponse]
647
+ #
648
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
649
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
650
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
651
+ def verify_project_location_ekm_connection_connectivity(name, fields: nil, quota_user: nil, options: nil, &block)
652
+ command = make_simple_command(:get, 'v1/{+name}:verifyConnectivity', options)
653
+ command.response_representation = Google::Apis::CloudkmsV1::VerifyConnectivityResponse::Representation
654
+ command.response_class = Google::Apis::CloudkmsV1::VerifyConnectivityResponse
655
+ command.params['name'] = name unless name.nil?
656
+ command.query['fields'] = fields unless fields.nil?
657
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
658
+ execute_or_queue_command(command, &block)
659
+ end
660
+
560
661
  # Create a new KeyRing in a given Project and Location.
561
662
  # @param [String] parent
562
663
  # Required. The resource name of the location associated with the KeyRings, in
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.36.0
4
+ version: 0.38.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-02-19 00:00:00.000000000 Z
11
+ date: 2023-04-16 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.36.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudkms_v1/v0.38.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: []