google-cloud-kms 1.0.2 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/kms/v1/credentials.rb +2 -1
  3. data/lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb +258 -149
  4. data/lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb +213 -157
  5. data/lib/google/cloud/kms/v1/helpers.rb +10 -0
  6. data/lib/google/cloud/kms/v1/key_management_service_client.rb +399 -143
  7. data/lib/google/cloud/kms/v1/key_management_service_client_config.json +20 -0
  8. data/lib/google/cloud/kms/v1/resources_pb.rb +38 -0
  9. data/lib/google/cloud/kms/v1/service_pb.rb +41 -2
  10. data/lib/google/cloud/kms/v1/service_services_pb.rb +49 -64
  11. data/lib/google/cloud/kms/version.rb +1 -1
  12. metadata +2 -2
data/lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb CHANGED
@@ -17,42 +17,41 @@ module Google
17
17
  module Cloud
18
18
  module Kms
19
19
  module V1
20
- # Request message for
21
- # {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}.
20
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}.
22
21
  # @!attribute [rw] parent
23
22
  # @return [String]
24
23
  # Required. The resource name of the location associated with the
25
- # {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format
26
- # `projects/*/locations/*`.
24
+ # {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format `projects/*/locations/*`.
27
25
  # @!attribute [rw] page_size
28
26
  # @return [Integer]
29
- # Optional limit on the number of {Google::Cloud::Kms::V1::KeyRing KeyRings} to
30
- # include in the response. Further {Google::Cloud::Kms::V1::KeyRing KeyRings}
31
- # can subsequently be obtained by including the
32
- # {Google::Cloud::Kms::V1::ListKeyRingsResponse#next_page_token ListKeyRingsResponse#next_page_token}
33
- # in a subsequent request. If unspecified, the server will pick an
34
- # appropriate default.
27
+ # Optional limit on the number of {Google::Cloud::Kms::V1::KeyRing KeyRings} to include in the
28
+ # response. Further {Google::Cloud::Kms::V1::KeyRing KeyRings} can subsequently be obtained by
29
+ # including the {Google::Cloud::Kms::V1::ListKeyRingsResponse#next_page_token ListKeyRingsResponse#next_page_token} in a subsequent
30
+ # request. If unspecified, the server will pick an appropriate default.
35
31
  # @!attribute [rw] page_token
36
32
  # @return [String]
37
33
  # Optional pagination token, returned earlier via
38
34
  # {Google::Cloud::Kms::V1::ListKeyRingsResponse#next_page_token ListKeyRingsResponse#next_page_token}.
35
+ # @!attribute [rw] filter
36
+ # @return [String]
37
+ # Optional. Only include resources that match the filter in the response.
38
+ # @!attribute [rw] order_by
39
+ # @return [String]
40
+ # Optional. Specify how the results should be sorted. If not specified, the
41
+ # results will be sorted in the default order.
39
42
  class ListKeyRingsRequest; end
40
43
 
41
- # Request message for
42
- # {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeys KeyManagementService::ListCryptoKeys}.
44
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeys KeyManagementService::ListCryptoKeys}.
43
45
  # @!attribute [rw] parent
44
46
  # @return [String]
45
- # Required. The resource name of the {Google::Cloud::Kms::V1::KeyRing KeyRing}
46
- # to list, in the format `projects/*/locations/*/keyRings/*`.
47
+ # Required. The resource name of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to list, in the format
48
+ # `projects/*/locations/*/keyRings/*`.
47
49
  # @!attribute [rw] page_size
48
50
  # @return [Integer]
49
- # Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}
50
- # to include in the response. Further
51
- # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} can subsequently be obtained by
52
- # including the
53
- # {Google::Cloud::Kms::V1::ListCryptoKeysResponse#next_page_token ListCryptoKeysResponse#next_page_token}
54
- # in a subsequent request. If unspecified, the server will pick an
55
- # appropriate default.
51
+ # Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} to include in the
52
+ # response. Further {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} can subsequently be obtained by
53
+ # including the {Google::Cloud::Kms::V1::ListCryptoKeysResponse#next_page_token ListCryptoKeysResponse#next_page_token} in a subsequent
54
+ # request. If unspecified, the server will pick an appropriate default.
56
55
  # @!attribute [rw] page_token
57
56
  # @return [String]
58
57
  # Optional pagination token, returned earlier via
@@ -60,24 +59,27 @@ module Google
60
59
  # @!attribute [rw] version_view
61
60
  # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView]
62
61
  # The fields of the primary version to include in the response.
62
+ # @!attribute [rw] filter
63
+ # @return [String]
64
+ # Optional. Only include resources that match the filter in the response.
65
+ # @!attribute [rw] order_by
66
+ # @return [String]
67
+ # Optional. Specify how the results should be sorted. If not specified, the
68
+ # results will be sorted in the default order.
63
69
  class ListCryptoKeysRequest; end
64
70
 
65
- # Request message for
66
- # {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}.
71
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}.
67
72
  # @!attribute [rw] parent
68
73
  # @return [String]
69
- # Required. The resource name of the
70
- # {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to list, in the format
74
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to list, in the format
71
75
  # `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
72
76
  # @!attribute [rw] page_size
73
77
  # @return [Integer]
74
- # Optional limit on the number of
75
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} to include in the
76
- # response. Further {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}
77
- # can subsequently be obtained by including the
78
- # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse#next_page_token ListCryptoKeyVersionsResponse#next_page_token}
79
- # in a subsequent request. If unspecified, the server will pick an
80
- # appropriate default.
78
+ # Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} to
79
+ # include in the response. Further {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} can
80
+ # subsequently be obtained by including the
81
+ # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse#next_page_token ListCryptoKeyVersionsResponse#next_page_token} in a subsequent request.
82
+ # If unspecified, the server will pick an appropriate default.
81
83
  # @!attribute [rw] page_token
82
84
  # @return [String]
83
85
  # Optional pagination token, returned earlier via
@@ -85,96 +87,129 @@ module Google
85
87
  # @!attribute [rw] view
86
88
  # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView]
87
89
  # The fields to include in the response.
90
+ # @!attribute [rw] filter
91
+ # @return [String]
92
+ # Optional. Only include resources that match the filter in the response.
93
+ # @!attribute [rw] order_by
94
+ # @return [String]
95
+ # Optional. Specify how the results should be sorted. If not specified, the
96
+ # results will be sorted in the default order.
88
97
  class ListCryptoKeyVersionsRequest; end
89
98
 
90
- # Response message for
91
- # {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}.
99
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListImportJobs KeyManagementService::ListImportJobs}.
100
+ # @!attribute [rw] parent
101
+ # @return [String]
102
+ # Required. The resource name of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to list, in the format
103
+ # `projects/*/locations/*/keyRings/*`.
104
+ # @!attribute [rw] page_size
105
+ # @return [Integer]
106
+ # Optional limit on the number of {Google::Cloud::Kms::V1::ImportJob ImportJobs} to include in the
107
+ # response. Further {Google::Cloud::Kms::V1::ImportJob ImportJobs} can subsequently be obtained by
108
+ # including the {Google::Cloud::Kms::V1::ListImportJobsResponse#next_page_token ListImportJobsResponse#next_page_token} in a subsequent
109
+ # request. If unspecified, the server will pick an appropriate default.
110
+ # @!attribute [rw] page_token
111
+ # @return [String]
112
+ # Optional pagination token, returned earlier via
113
+ # {Google::Cloud::Kms::V1::ListImportJobsResponse#next_page_token ListImportJobsResponse#next_page_token}.
114
+ # @!attribute [rw] filter
115
+ # @return [String]
116
+ # Optional. Only include resources that match the filter in the response.
117
+ # @!attribute [rw] order_by
118
+ # @return [String]
119
+ # Optional. Specify how the results should be sorted. If not specified, the
120
+ # results will be sorted in the default order.
121
+ class ListImportJobsRequest; end
122
+
123
+ # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}.
92
124
  # @!attribute [rw] key_rings
93
125
  # @return [Array<Google::Cloud::Kms::V1::KeyRing>]
94
126
  # The list of {Google::Cloud::Kms::V1::KeyRing KeyRings}.
95
127
  # @!attribute [rw] next_page_token
96
128
  # @return [String]
97
129
  # A token to retrieve next page of results. Pass this value in
98
- # {Google::Cloud::Kms::V1::ListKeyRingsRequest#page_token ListKeyRingsRequest#page_token}
99
- # to retrieve the next page of results.
130
+ # {Google::Cloud::Kms::V1::ListKeyRingsRequest#page_token ListKeyRingsRequest#page_token} to retrieve the next page of results.
100
131
  # @!attribute [rw] total_size
101
132
  # @return [Integer]
102
- # The total number of {Google::Cloud::Kms::V1::KeyRing KeyRings} that matched
103
- # the query.
133
+ # The total number of {Google::Cloud::Kms::V1::KeyRing KeyRings} that matched the query.
104
134
  class ListKeyRingsResponse; end
105
135
 
106
- # Response message for
107
- # {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeys KeyManagementService::ListCryptoKeys}.
136
+ # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeys KeyManagementService::ListCryptoKeys}.
108
137
  # @!attribute [rw] crypto_keys
109
138
  # @return [Array<Google::Cloud::Kms::V1::CryptoKey>]
110
139
  # The list of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
111
140
  # @!attribute [rw] next_page_token
112
141
  # @return [String]
113
142
  # A token to retrieve next page of results. Pass this value in
114
- # {Google::Cloud::Kms::V1::ListCryptoKeysRequest#page_token ListCryptoKeysRequest#page_token}
115
- # to retrieve the next page of results.
143
+ # {Google::Cloud::Kms::V1::ListCryptoKeysRequest#page_token ListCryptoKeysRequest#page_token} to retrieve the next page of results.
116
144
  # @!attribute [rw] total_size
117
145
  # @return [Integer]
118
- # The total number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} that
119
- # matched the query.
146
+ # The total number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} that matched the query.
120
147
  class ListCryptoKeysResponse; end
121
148
 
122
- # Response message for
123
- # {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}.
149
+ # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}.
124
150
  # @!attribute [rw] crypto_key_versions
125
151
  # @return [Array<Google::Cloud::Kms::V1::CryptoKeyVersion>]
126
152
  # The list of {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}.
127
153
  # @!attribute [rw] next_page_token
128
154
  # @return [String]
129
155
  # A token to retrieve next page of results. Pass this value in
130
- # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest#page_token ListCryptoKeyVersionsRequest#page_token}
131
- # to retrieve the next page of results.
156
+ # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest#page_token ListCryptoKeyVersionsRequest#page_token} to retrieve the next page of
157
+ # results.
132
158
  # @!attribute [rw] total_size
133
159
  # @return [Integer]
134
- # The total number of
135
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} that matched the
160
+ # The total number of {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} that matched the
136
161
  # query.
137
162
  class ListCryptoKeyVersionsResponse; end
138
163
 
139
- # Request message for
140
- # {Google::Cloud::Kms::V1::KeyManagementService::GetKeyRing KeyManagementService::GetKeyRing}.
164
+ # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListImportJobs KeyManagementService::ListImportJobs}.
165
+ # @!attribute [rw] import_jobs
166
+ # @return [Array<Google::Cloud::Kms::V1::ImportJob>]
167
+ # The list of {Google::Cloud::Kms::V1::ImportJob ImportJobs}.
168
+ # @!attribute [rw] next_page_token
169
+ # @return [String]
170
+ # A token to retrieve next page of results. Pass this value in
171
+ # {Google::Cloud::Kms::V1::ListImportJobsRequest#page_token ListImportJobsRequest#page_token} to retrieve the next page of results.
172
+ # @!attribute [rw] total_size
173
+ # @return [Integer]
174
+ # The total number of {Google::Cloud::Kms::V1::ImportJob ImportJobs} that matched the query.
175
+ class ListImportJobsResponse; end
176
+
177
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetKeyRing KeyManagementService::GetKeyRing}.
141
178
  # @!attribute [rw] name
142
179
  # @return [String]
143
- # The {Google::Cloud::Kms::V1::KeyRing#name name} of the
144
- # {Google::Cloud::Kms::V1::KeyRing KeyRing} to get.
180
+ # The {Google::Cloud::Kms::V1::KeyRing#name name} of the {Google::Cloud::Kms::V1::KeyRing KeyRing} to get.
145
181
  class GetKeyRingRequest; end
146
182
 
147
- # Request message for
148
- # {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKey KeyManagementService::GetCryptoKey}.
183
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKey KeyManagementService::GetCryptoKey}.
149
184
  # @!attribute [rw] name
150
185
  # @return [String]
151
- # The {Google::Cloud::Kms::V1::CryptoKey#name name} of the
152
- # {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to get.
186
+ # The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to get.
153
187
  class GetCryptoKeyRequest; end
154
188
 
155
- # Request message for
156
- # {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKeyVersion KeyManagementService::GetCryptoKeyVersion}.
189
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKeyVersion KeyManagementService::GetCryptoKeyVersion}.
157
190
  # @!attribute [rw] name
158
191
  # @return [String]
159
- # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the
160
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to get.
192
+ # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to get.
161
193
  class GetCryptoKeyVersionRequest; end
162
194
 
163
- # Request message for
164
- # {Google::Cloud::Kms::V1::KeyManagementService::GetPublicKey KeyManagementService::GetPublicKey}.
195
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetPublicKey KeyManagementService::GetPublicKey}.
165
196
  # @!attribute [rw] name
166
197
  # @return [String]
167
- # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the
168
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} public key to get.
198
+ # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} public key to
199
+ # get.
169
200
  class GetPublicKeyRequest; end
170
201
 
171
- # Request message for
172
- # {Google::Cloud::Kms::V1::KeyManagementService::CreateKeyRing KeyManagementService::CreateKeyRing}.
202
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetImportJob KeyManagementService::GetImportJob}.
203
+ # @!attribute [rw] name
204
+ # @return [String]
205
+ # The {Google::Cloud::Kms::V1::ImportJob#name name} of the {Google::Cloud::Kms::V1::ImportJob ImportJob} to get.
206
+ class GetImportJobRequest; end
207
+
208
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateKeyRing KeyManagementService::CreateKeyRing}.
173
209
  # @!attribute [rw] parent
174
210
  # @return [String]
175
211
  # Required. The resource name of the location associated with the
176
- # {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format
177
- # `projects/*/locations/*`.
212
+ # {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format `projects/*/locations/*`.
178
213
  # @!attribute [rw] key_ring_id
179
214
  # @return [String]
180
215
  # Required. It must be unique within a location and match the regular
@@ -184,12 +219,11 @@ module Google
184
219
  # A {Google::Cloud::Kms::V1::KeyRing KeyRing} with initial field values.
185
220
  class CreateKeyRingRequest; end
186
221
 
187
- # Request message for
188
- # {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKey KeyManagementService::CreateCryptoKey}.
222
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKey KeyManagementService::CreateCryptoKey}.
189
223
  # @!attribute [rw] parent
190
224
  # @return [String]
191
- # Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the KeyRing
192
- # associated with the {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
225
+ # Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the KeyRing associated with the
226
+ # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
193
227
  # @!attribute [rw] crypto_key_id
194
228
  # @return [String]
195
229
  # Required. It must be unique within a KeyRing and match the regular
@@ -197,23 +231,77 @@ module Google
197
231
  # @!attribute [rw] crypto_key
198
232
  # @return [Google::Cloud::Kms::V1::CryptoKey]
199
233
  # A {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with initial field values.
234
+ # @!attribute [rw] skip_initial_version_creation
235
+ # @return [true, false]
236
+ # If set to true, the request will create a {Google::Cloud::Kms::V1::CryptoKey CryptoKey} without any
237
+ # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}. You must manually call
238
+ # {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKeyVersion CreateCryptoKeyVersion} or
239
+ # {Google::Cloud::Kms::V1::KeyManagementService::ImportCryptoKeyVersion ImportCryptoKeyVersion}
240
+ # before you can use this {Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
200
241
  class CreateCryptoKeyRequest; end
201
242
 
202
- # Request message for
203
- # {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKeyVersion KeyManagementService::CreateCryptoKeyVersion}.
243
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKeyVersion KeyManagementService::CreateCryptoKeyVersion}.
204
244
  # @!attribute [rw] parent
205
245
  # @return [String]
206
- # Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the
207
- # {Google::Cloud::Kms::V1::CryptoKey CryptoKey} associated with the
208
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}.
246
+ # Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} associated with
247
+ # the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}.
209
248
  # @!attribute [rw] crypto_key_version
210
249
  # @return [Google::Cloud::Kms::V1::CryptoKeyVersion]
211
- # A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with initial
212
- # field values.
250
+ # A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with initial field values.
213
251
  class CreateCryptoKeyVersionRequest; end
214
252
 
215
- # Request message for
216
- # {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKey KeyManagementService::UpdateCryptoKey}.
253
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ImportCryptoKeyVersion KeyManagementService::ImportCryptoKeyVersion}.
254
+ # @!attribute [rw] parent
255
+ # @return [String]
256
+ # Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to
257
+ # be imported into.
258
+ # @!attribute [rw] algorithm
259
+ # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm]
260
+ # Required. The {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm algorithm} of
261
+ # the key being imported. This does not need to match the
262
+ # {Google::Cloud::Kms::V1::CryptoKey#version_template version_template} of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} this
263
+ # version imports into.
264
+ # @!attribute [rw] import_job
265
+ # @return [String]
266
+ # Required. The {Google::Cloud::Kms::V1::ImportJob#name name} of the {Google::Cloud::Kms::V1::ImportJob ImportJob} that was used to
267
+ # wrap this key material.
268
+ # @!attribute [rw] rsa_aes_wrapped_key
269
+ # @return [String]
270
+ # Wrapped key material produced with
271
+ # {Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_3072_SHA1_AES_256 RSA_OAEP_3072_SHA1_AES_256}
272
+ # or
273
+ # {Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_4096_SHA1_AES_256 RSA_OAEP_4096_SHA1_AES_256}.
274
+ #
275
+ # This field contains the concatenation of two wrapped keys:
276
+ # <ol>
277
+ # <li>An ephemeral AES-256 wrapping key wrapped with the
278
+ # {Google::Cloud::Kms::V1::ImportJob#public_key public_key} using RSAES-OAEP with SHA-1,
279
+ # MGF1 with SHA-1, and an empty label.
280
+ # </li>
281
+ # <li>The key to be imported, wrapped with the ephemeral AES-256 key
282
+ # using AES-KWP (RFC 5649).
283
+ # </li>
284
+ # </ol>
285
+ #
286
+ # This format is the same as the format produced by PKCS#11 mechanism
287
+ # CKM_RSA_AES_KEY_WRAP.
288
+ class ImportCryptoKeyVersionRequest; end
289
+
290
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateImportJob KeyManagementService::CreateImportJob}.
291
+ # @!attribute [rw] parent
292
+ # @return [String]
293
+ # Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the {Google::Cloud::Kms::V1::KeyRing KeyRing} associated with the
294
+ # {Google::Cloud::Kms::V1::ImportJob ImportJobs}.
295
+ # @!attribute [rw] import_job_id
296
+ # @return [String]
297
+ # Required. It must be unique within a KeyRing and match the regular
298
+ # expression `[a-zA-Z0-9_-]{1,63}`
299
+ # @!attribute [rw] import_job
300
+ # @return [Google::Cloud::Kms::V1::ImportJob]
301
+ # Required. An {Google::Cloud::Kms::V1::ImportJob ImportJob} with initial field values.
302
+ class CreateImportJobRequest; end
303
+
304
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKey KeyManagementService::UpdateCryptoKey}.
217
305
  # @!attribute [rw] crypto_key
218
306
  # @return [Google::Cloud::Kms::V1::CryptoKey]
219
307
  # {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with updated values.
@@ -222,61 +310,51 @@ module Google
222
310
  # Required list of fields to be updated in this request.
223
311
  class UpdateCryptoKeyRequest; end
224
312
 
225
- # Request message for
226
- # {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyVersion KeyManagementService::UpdateCryptoKeyVersion}.
313
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyVersion KeyManagementService::UpdateCryptoKeyVersion}.
227
314
  # @!attribute [rw] crypto_key_version
228
315
  # @return [Google::Cloud::Kms::V1::CryptoKeyVersion]
229
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with updated
230
- # values.
316
+ # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with updated values.
231
317
  # @!attribute [rw] update_mask
232
318
  # @return [Google::Protobuf::FieldMask]
233
319
  # Required list of fields to be updated in this request.
234
320
  class UpdateCryptoKeyVersionRequest; end
235
321
 
236
- # Request message for
237
- # {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
322
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
238
323
  # @!attribute [rw] name
239
324
  # @return [String]
240
- # Required. The resource name of the
241
- # {Google::Cloud::Kms::V1::CryptoKey CryptoKey} or
242
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for
243
- # encryption.
325
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} or {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}
326
+ # to use for encryption.
244
327
  #
245
- # If a {Google::Cloud::Kms::V1::CryptoKey CryptoKey} is specified, the server
246
- # will use its {Google::Cloud::Kms::V1::CryptoKey#primary primary version}.
328
+ # If a {Google::Cloud::Kms::V1::CryptoKey CryptoKey} is specified, the server will use its
329
+ # {Google::Cloud::Kms::V1::CryptoKey#primary primary version}.
247
330
  # @!attribute [rw] plaintext
248
331
  # @return [String]
249
332
  # Required. The data to encrypt. Must be no larger than 64KiB.
250
333
  #
251
334
  # The maximum size depends on the key version's
252
- # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}.
253
- # For {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the
254
- # plaintext must be no larger than 64KiB. For
255
- # {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of
256
- # the plaintext and additional_authenticated_data fields must be no larger
257
- # than 8KiB.
335
+ # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}. For
336
+ # {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the plaintext must be no larger
337
+ # than 64KiB. For {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of the
338
+ # plaintext and additional_authenticated_data fields must be no larger than
339
+ # 8KiB.
258
340
  # @!attribute [rw] additional_authenticated_data
259
341
  # @return [String]
260
342
  # Optional data that, if specified, must also be provided during decryption
261
- # through
262
- # {Google::Cloud::Kms::V1::DecryptRequest#additional_authenticated_data DecryptRequest#additional_authenticated_data}.
343
+ # through {Google::Cloud::Kms::V1::DecryptRequest#additional_authenticated_data DecryptRequest#additional_authenticated_data}.
263
344
  #
264
345
  # The maximum size depends on the key version's
265
- # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}.
266
- # For {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the AAD
267
- # must be no larger than 64KiB. For
268
- # {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of
269
- # the plaintext and additional_authenticated_data fields must be no larger
270
- # than 8KiB.
346
+ # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}. For
347
+ # {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the AAD must be no larger than
348
+ # 64KiB. For {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of the
349
+ # plaintext and additional_authenticated_data fields must be no larger than
350
+ # 8KiB.
271
351
  class EncryptRequest; end
272
352
 
273
- # Request message for
274
- # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}.
353
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}.
275
354
  # @!attribute [rw] name
276
355
  # @return [String]
277
- # Required. The resource name of the
278
- # {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to use for decryption. The
279
- # server will choose the appropriate version.
356
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to use for decryption.
357
+ # The server will choose the appropriate version.
280
358
  # @!attribute [rw] ciphertext
281
359
  # @return [String]
282
360
  # Required. The encrypted data originally returned in
@@ -287,13 +365,10 @@ module Google
287
365
  # {Google::Cloud::Kms::V1::EncryptRequest#additional_authenticated_data EncryptRequest#additional_authenticated_data}.
288
366
  class DecryptRequest; end
289
367
 
290
- # Request message for
291
- # {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}.
368
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}.
292
369
  # @!attribute [rw] name
293
370
  # @return [String]
294
- # Required. The resource name of the
295
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for
296
- # signing.
371
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for signing.
297
372
  # @!attribute [rw] digest
298
373
  # @return [Google::Cloud::Kms::V1::Digest]
299
374
  # Required. The digest of the data to sign. The digest must be produced with
@@ -301,80 +376,63 @@ module Google
301
376
  # {Google::Cloud::Kms::V1::CryptoKeyVersion#algorithm algorithm}.
302
377
  class AsymmetricSignRequest; end
303
378
 
304
- # Request message for
305
- # {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}.
379
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}.
306
380
  # @!attribute [rw] name
307
381
  # @return [String]
308
- # Required. The resource name of the
309
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for
382
+ # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for
310
383
  # decryption.
311
384
  # @!attribute [rw] ciphertext
312
385
  # @return [String]
313
- # Required. The data encrypted with the named
314
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s public key using
315
- # OAEP.
386
+ # Required. The data encrypted with the named {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s public
387
+ # key using OAEP.
316
388
  class AsymmetricDecryptRequest; end
317
389
 
318
- # Response message for
319
- # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}.
390
+ # Response message for {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}.
320
391
  # @!attribute [rw] plaintext
321
392
  # @return [String]
322
- # The decrypted data originally supplied in
323
- # {Google::Cloud::Kms::V1::EncryptRequest#plaintext EncryptRequest#plaintext}.
393
+ # The decrypted data originally supplied in {Google::Cloud::Kms::V1::EncryptRequest#plaintext EncryptRequest#plaintext}.
324
394
  class DecryptResponse; end
325
395
 
326
- # Response message for
327
- # {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
396
+ # Response message for {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
328
397
  # @!attribute [rw] name
329
398
  # @return [String]
330
- # The resource name of the
331
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} used in
332
- # encryption.
399
+ # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} used in encryption.
333
400
  # @!attribute [rw] ciphertext
334
401
  # @return [String]
335
402
  # The encrypted data.
336
403
  class EncryptResponse; end
337
404
 
338
- # Response message for
339
- # {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}.
405
+ # Response message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}.
340
406
  # @!attribute [rw] signature
341
407
  # @return [String]
342
408
  # The created signature.
343
409
  class AsymmetricSignResponse; end
344
410
 
345
- # Response message for
346
- # {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}.
411
+ # Response message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}.
347
412
  # @!attribute [rw] plaintext
348
413
  # @return [String]
349
414
  # The decrypted data originally encrypted with the matching public key.
350
415
  class AsymmetricDecryptResponse; end
351
416
 
352
- # Request message for
353
- # {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyPrimaryVersion KeyManagementService::UpdateCryptoKeyPrimaryVersion}.
417
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyPrimaryVersion KeyManagementService::UpdateCryptoKeyPrimaryVersion}.
354
418
  # @!attribute [rw] name
355
419
  # @return [String]
356
- # The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to
357
- # update.
420
+ # The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to update.
358
421
  # @!attribute [rw] crypto_key_version_id
359
422
  # @return [String]
360
- # The id of the child
361
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use as primary.
423
+ # The id of the child {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use as primary.
362
424
  class UpdateCryptoKeyPrimaryVersionRequest; end
363
425
 
364
- # Request message for
365
- # {Google::Cloud::Kms::V1::KeyManagementService::DestroyCryptoKeyVersion KeyManagementService::DestroyCryptoKeyVersion}.
426
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::DestroyCryptoKeyVersion KeyManagementService::DestroyCryptoKeyVersion}.
366
427
  # @!attribute [rw] name
367
428
  # @return [String]
368
- # The resource name of the
369
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to destroy.
429
+ # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to destroy.
370
430
  class DestroyCryptoKeyVersionRequest; end
371
431
 
372
- # Request message for
373
- # {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion KeyManagementService::RestoreCryptoKeyVersion}.
432
+ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion KeyManagementService::RestoreCryptoKeyVersion}.
374
433
  # @!attribute [rw] name
375
434
  # @return [String]
376
- # The resource name of the
377
- # {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to restore.
435
+ # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to restore.
378
436
  class RestoreCryptoKeyVersionRequest; end
379
437
 
380
438
  # A {Google::Cloud::Kms::V1::Digest Digest} holds a cryptographic message digest.
@@ -389,14 +447,12 @@ module Google
389
447
  # A message digest produced with the SHA-512 algorithm.
390
448
  class Digest; end
391
449
 
392
- # Cloud KMS metadata for the given
393
- # {Google::Cloud::Location::Location}.
450
+ # Cloud KMS metadata for the given {Google::Cloud::Location::Location}.
394
451
  # @!attribute [rw] hsm_available
395
452
  # @return [true, false]
396
453
  # Indicates whether {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with
397
454
  # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}
398
- # {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} can be created in this
399
- # location.
455
+ # {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} can be created in this location.
400
456
  class LocationMetadata; end
401
457
  end
402
458
  end