google-cloud-kms 0.3.0 → 1.0.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 +4 -4
- data/README.md +22 -1
- data/lib/google/cloud/kms.rb +1 -1
- data/lib/google/cloud/kms/v1.rb +1 -1
- data/lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb +150 -84
- data/lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb +157 -91
- data/lib/google/cloud/kms/v1/key_management_service_client.rb +128 -76
- data/lib/google/cloud/kms/v1/resources_pb.rb +1 -0
- data/lib/google/cloud/kms/v1/service_services_pb.rb +63 -34
- metadata +4 -4
|
@@ -17,34 +17,42 @@ module Google
|
|
|
17
17
|
module Cloud
|
|
18
18
|
module Kms
|
|
19
19
|
module V1
|
|
20
|
-
# Request message for
|
|
20
|
+
# Request message for
|
|
21
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}.
|
|
21
22
|
# @!attribute [rw] parent
|
|
22
23
|
# @return [String]
|
|
23
24
|
# Required. The resource name of the location associated with the
|
|
24
|
-
# {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format
|
|
25
|
+
# {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format
|
|
26
|
+
# `projects/*/locations/*`.
|
|
25
27
|
# @!attribute [rw] page_size
|
|
26
28
|
# @return [Integer]
|
|
27
|
-
# Optional limit on the number of {Google::Cloud::Kms::V1::KeyRing KeyRings} to
|
|
28
|
-
# response. Further {Google::Cloud::Kms::V1::KeyRing KeyRings}
|
|
29
|
-
#
|
|
30
|
-
#
|
|
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.
|
|
31
35
|
# @!attribute [rw] page_token
|
|
32
36
|
# @return [String]
|
|
33
37
|
# Optional pagination token, returned earlier via
|
|
34
38
|
# {Google::Cloud::Kms::V1::ListKeyRingsResponse#next_page_token ListKeyRingsResponse#next_page_token}.
|
|
35
39
|
class ListKeyRingsRequest; end
|
|
36
40
|
|
|
37
|
-
# Request message for
|
|
41
|
+
# Request message for
|
|
42
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeys KeyManagementService::ListCryptoKeys}.
|
|
38
43
|
# @!attribute [rw] parent
|
|
39
44
|
# @return [String]
|
|
40
|
-
# Required. The resource name of the {Google::Cloud::Kms::V1::KeyRing KeyRing}
|
|
41
|
-
# `projects/*/locations/*/keyRings/*`.
|
|
45
|
+
# Required. The resource name of the {Google::Cloud::Kms::V1::KeyRing KeyRing}
|
|
46
|
+
# to list, in the format `projects/*/locations/*/keyRings/*`.
|
|
42
47
|
# @!attribute [rw] page_size
|
|
43
48
|
# @return [Integer]
|
|
44
|
-
# Optional limit on the number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}
|
|
45
|
-
# response. Further
|
|
46
|
-
#
|
|
47
|
-
#
|
|
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.
|
|
48
56
|
# @!attribute [rw] page_token
|
|
49
57
|
# @return [String]
|
|
50
58
|
# Optional pagination token, returned earlier via
|
|
@@ -54,18 +62,22 @@ module Google
|
|
|
54
62
|
# The fields of the primary version to include in the response.
|
|
55
63
|
class ListCryptoKeysRequest; end
|
|
56
64
|
|
|
57
|
-
# Request message for
|
|
65
|
+
# Request message for
|
|
66
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}.
|
|
58
67
|
# @!attribute [rw] parent
|
|
59
68
|
# @return [String]
|
|
60
|
-
# Required. The resource name of the
|
|
69
|
+
# Required. The resource name of the
|
|
70
|
+
# {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to list, in the format
|
|
61
71
|
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
|
|
62
72
|
# @!attribute [rw] page_size
|
|
63
73
|
# @return [Integer]
|
|
64
|
-
# Optional limit on the number of
|
|
65
|
-
#
|
|
66
|
-
#
|
|
67
|
-
#
|
|
68
|
-
#
|
|
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.
|
|
69
81
|
# @!attribute [rw] page_token
|
|
70
82
|
# @return [String]
|
|
71
83
|
# Optional pagination token, returned earlier via
|
|
@@ -75,77 +87,94 @@ module Google
|
|
|
75
87
|
# The fields to include in the response.
|
|
76
88
|
class ListCryptoKeyVersionsRequest; end
|
|
77
89
|
|
|
78
|
-
# Response message for
|
|
90
|
+
# Response message for
|
|
91
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}.
|
|
79
92
|
# @!attribute [rw] key_rings
|
|
80
93
|
# @return [Array<Google::Cloud::Kms::V1::KeyRing>]
|
|
81
94
|
# The list of {Google::Cloud::Kms::V1::KeyRing KeyRings}.
|
|
82
95
|
# @!attribute [rw] next_page_token
|
|
83
96
|
# @return [String]
|
|
84
97
|
# A token to retrieve next page of results. Pass this value in
|
|
85
|
-
# {Google::Cloud::Kms::V1::ListKeyRingsRequest#page_token ListKeyRingsRequest#page_token}
|
|
98
|
+
# {Google::Cloud::Kms::V1::ListKeyRingsRequest#page_token ListKeyRingsRequest#page_token}
|
|
99
|
+
# to retrieve the next page of results.
|
|
86
100
|
# @!attribute [rw] total_size
|
|
87
101
|
# @return [Integer]
|
|
88
|
-
# The total number of {Google::Cloud::Kms::V1::KeyRing KeyRings} that matched
|
|
102
|
+
# The total number of {Google::Cloud::Kms::V1::KeyRing KeyRings} that matched
|
|
103
|
+
# the query.
|
|
89
104
|
class ListKeyRingsResponse; end
|
|
90
105
|
|
|
91
|
-
# Response message for
|
|
106
|
+
# Response message for
|
|
107
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeys KeyManagementService::ListCryptoKeys}.
|
|
92
108
|
# @!attribute [rw] crypto_keys
|
|
93
109
|
# @return [Array<Google::Cloud::Kms::V1::CryptoKey>]
|
|
94
110
|
# The list of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
|
|
95
111
|
# @!attribute [rw] next_page_token
|
|
96
112
|
# @return [String]
|
|
97
113
|
# A token to retrieve next page of results. Pass this value in
|
|
98
|
-
# {Google::Cloud::Kms::V1::ListCryptoKeysRequest#page_token ListCryptoKeysRequest#page_token}
|
|
114
|
+
# {Google::Cloud::Kms::V1::ListCryptoKeysRequest#page_token ListCryptoKeysRequest#page_token}
|
|
115
|
+
# to retrieve the next page of results.
|
|
99
116
|
# @!attribute [rw] total_size
|
|
100
117
|
# @return [Integer]
|
|
101
|
-
# The total number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} that
|
|
118
|
+
# The total number of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} that
|
|
119
|
+
# matched the query.
|
|
102
120
|
class ListCryptoKeysResponse; end
|
|
103
121
|
|
|
104
|
-
# Response message for
|
|
122
|
+
# Response message for
|
|
123
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}.
|
|
105
124
|
# @!attribute [rw] crypto_key_versions
|
|
106
125
|
# @return [Array<Google::Cloud::Kms::V1::CryptoKeyVersion>]
|
|
107
126
|
# The list of {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions}.
|
|
108
127
|
# @!attribute [rw] next_page_token
|
|
109
128
|
# @return [String]
|
|
110
129
|
# A token to retrieve next page of results. Pass this value in
|
|
111
|
-
# {Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest#page_token ListCryptoKeyVersionsRequest#page_token}
|
|
112
|
-
# results.
|
|
130
|
+
# {Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest#page_token ListCryptoKeyVersionsRequest#page_token}
|
|
131
|
+
# to retrieve the next page of results.
|
|
113
132
|
# @!attribute [rw] total_size
|
|
114
133
|
# @return [Integer]
|
|
115
|
-
# The total number of
|
|
134
|
+
# The total number of
|
|
135
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} that matched the
|
|
116
136
|
# query.
|
|
117
137
|
class ListCryptoKeyVersionsResponse; end
|
|
118
138
|
|
|
119
|
-
# Request message for
|
|
139
|
+
# Request message for
|
|
140
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::GetKeyRing KeyManagementService::GetKeyRing}.
|
|
120
141
|
# @!attribute [rw] name
|
|
121
142
|
# @return [String]
|
|
122
|
-
# The {Google::Cloud::Kms::V1::KeyRing#name name} of the
|
|
143
|
+
# The {Google::Cloud::Kms::V1::KeyRing#name name} of the
|
|
144
|
+
# {Google::Cloud::Kms::V1::KeyRing KeyRing} to get.
|
|
123
145
|
class GetKeyRingRequest; end
|
|
124
146
|
|
|
125
|
-
# Request message for
|
|
147
|
+
# Request message for
|
|
148
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKey KeyManagementService::GetCryptoKey}.
|
|
126
149
|
# @!attribute [rw] name
|
|
127
150
|
# @return [String]
|
|
128
|
-
# The {Google::Cloud::Kms::V1::CryptoKey#name name} of the
|
|
151
|
+
# The {Google::Cloud::Kms::V1::CryptoKey#name name} of the
|
|
152
|
+
# {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to get.
|
|
129
153
|
class GetCryptoKeyRequest; end
|
|
130
154
|
|
|
131
|
-
# Request message for
|
|
155
|
+
# Request message for
|
|
156
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::GetCryptoKeyVersion KeyManagementService::GetCryptoKeyVersion}.
|
|
132
157
|
# @!attribute [rw] name
|
|
133
158
|
# @return [String]
|
|
134
|
-
# The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the
|
|
159
|
+
# The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the
|
|
160
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to get.
|
|
135
161
|
class GetCryptoKeyVersionRequest; end
|
|
136
162
|
|
|
137
|
-
# Request message for
|
|
163
|
+
# Request message for
|
|
164
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::GetPublicKey KeyManagementService::GetPublicKey}.
|
|
138
165
|
# @!attribute [rw] name
|
|
139
166
|
# @return [String]
|
|
140
|
-
# The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the
|
|
141
|
-
# get.
|
|
167
|
+
# The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the
|
|
168
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} public key to get.
|
|
142
169
|
class GetPublicKeyRequest; end
|
|
143
170
|
|
|
144
|
-
# Request message for
|
|
171
|
+
# Request message for
|
|
172
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::CreateKeyRing KeyManagementService::CreateKeyRing}.
|
|
145
173
|
# @!attribute [rw] parent
|
|
146
174
|
# @return [String]
|
|
147
175
|
# Required. The resource name of the location associated with the
|
|
148
|
-
# {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format
|
|
176
|
+
# {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format
|
|
177
|
+
# `projects/*/locations/*`.
|
|
149
178
|
# @!attribute [rw] key_ring_id
|
|
150
179
|
# @return [String]
|
|
151
180
|
# Required. It must be unique within a location and match the regular
|
|
@@ -155,11 +184,12 @@ module Google
|
|
|
155
184
|
# A {Google::Cloud::Kms::V1::KeyRing KeyRing} with initial field values.
|
|
156
185
|
class CreateKeyRingRequest; end
|
|
157
186
|
|
|
158
|
-
# Request message for
|
|
187
|
+
# Request message for
|
|
188
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKey KeyManagementService::CreateCryptoKey}.
|
|
159
189
|
# @!attribute [rw] parent
|
|
160
190
|
# @return [String]
|
|
161
|
-
# Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the KeyRing
|
|
162
|
-
# {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
|
|
191
|
+
# Required. The {Google::Cloud::Kms::V1::KeyRing#name name} of the KeyRing
|
|
192
|
+
# associated with the {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
|
|
163
193
|
# @!attribute [rw] crypto_key_id
|
|
164
194
|
# @return [String]
|
|
165
195
|
# Required. It must be unique within a KeyRing and match the regular
|
|
@@ -169,17 +199,21 @@ module Google
|
|
|
169
199
|
# A {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with initial field values.
|
|
170
200
|
class CreateCryptoKeyRequest; end
|
|
171
201
|
|
|
172
|
-
# Request message for
|
|
202
|
+
# Request message for
|
|
203
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::CreateCryptoKeyVersion KeyManagementService::CreateCryptoKeyVersion}.
|
|
173
204
|
# @!attribute [rw] parent
|
|
174
205
|
# @return [String]
|
|
175
|
-
# Required. The {Google::Cloud::Kms::V1::CryptoKey#name name} of the
|
|
176
|
-
#
|
|
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}.
|
|
177
209
|
# @!attribute [rw] crypto_key_version
|
|
178
210
|
# @return [Google::Cloud::Kms::V1::CryptoKeyVersion]
|
|
179
|
-
# A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with initial
|
|
211
|
+
# A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with initial
|
|
212
|
+
# field values.
|
|
180
213
|
class CreateCryptoKeyVersionRequest; end
|
|
181
214
|
|
|
182
|
-
# Request message for
|
|
215
|
+
# Request message for
|
|
216
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKey KeyManagementService::UpdateCryptoKey}.
|
|
183
217
|
# @!attribute [rw] crypto_key
|
|
184
218
|
# @return [Google::Cloud::Kms::V1::CryptoKey]
|
|
185
219
|
# {Google::Cloud::Kms::V1::CryptoKey CryptoKey} with updated values.
|
|
@@ -188,51 +222,61 @@ module Google
|
|
|
188
222
|
# Required list of fields to be updated in this request.
|
|
189
223
|
class UpdateCryptoKeyRequest; end
|
|
190
224
|
|
|
191
|
-
# Request message for
|
|
225
|
+
# Request message for
|
|
226
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyVersion KeyManagementService::UpdateCryptoKeyVersion}.
|
|
192
227
|
# @!attribute [rw] crypto_key_version
|
|
193
228
|
# @return [Google::Cloud::Kms::V1::CryptoKeyVersion]
|
|
194
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with updated
|
|
229
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} with updated
|
|
230
|
+
# values.
|
|
195
231
|
# @!attribute [rw] update_mask
|
|
196
232
|
# @return [Google::Protobuf::FieldMask]
|
|
197
233
|
# Required list of fields to be updated in this request.
|
|
198
234
|
class UpdateCryptoKeyVersionRequest; end
|
|
199
235
|
|
|
200
|
-
# Request message for
|
|
236
|
+
# Request message for
|
|
237
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
|
|
201
238
|
# @!attribute [rw] name
|
|
202
239
|
# @return [String]
|
|
203
|
-
# Required. The resource name of the
|
|
204
|
-
#
|
|
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.
|
|
205
244
|
#
|
|
206
|
-
# If a {Google::Cloud::Kms::V1::CryptoKey CryptoKey} is specified, the server
|
|
207
|
-
# {Google::Cloud::Kms::V1::CryptoKey#primary primary version}.
|
|
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}.
|
|
208
247
|
# @!attribute [rw] plaintext
|
|
209
248
|
# @return [String]
|
|
210
249
|
# Required. The data to encrypt. Must be no larger than 64KiB.
|
|
211
250
|
#
|
|
212
251
|
# The maximum size depends on the key version's
|
|
213
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}.
|
|
214
|
-
# {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the
|
|
215
|
-
#
|
|
216
|
-
#
|
|
217
|
-
#
|
|
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.
|
|
218
258
|
# @!attribute [rw] additional_authenticated_data
|
|
219
259
|
# @return [String]
|
|
220
260
|
# Optional data that, if specified, must also be provided during decryption
|
|
221
|
-
# through
|
|
261
|
+
# through
|
|
262
|
+
# {Google::Cloud::Kms::V1::DecryptRequest#additional_authenticated_data DecryptRequest#additional_authenticated_data}.
|
|
222
263
|
#
|
|
223
264
|
# The maximum size depends on the key version's
|
|
224
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}.
|
|
225
|
-
# {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the AAD
|
|
226
|
-
#
|
|
227
|
-
#
|
|
228
|
-
#
|
|
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.
|
|
229
271
|
class EncryptRequest; end
|
|
230
272
|
|
|
231
|
-
# Request message for
|
|
273
|
+
# Request message for
|
|
274
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}.
|
|
232
275
|
# @!attribute [rw] name
|
|
233
276
|
# @return [String]
|
|
234
|
-
# Required. The resource name of the
|
|
235
|
-
#
|
|
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.
|
|
236
280
|
# @!attribute [rw] ciphertext
|
|
237
281
|
# @return [String]
|
|
238
282
|
# Required. The encrypted data originally returned in
|
|
@@ -243,10 +287,13 @@ module Google
|
|
|
243
287
|
# {Google::Cloud::Kms::V1::EncryptRequest#additional_authenticated_data EncryptRequest#additional_authenticated_data}.
|
|
244
288
|
class DecryptRequest; end
|
|
245
289
|
|
|
246
|
-
# Request message for
|
|
290
|
+
# Request message for
|
|
291
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}.
|
|
247
292
|
# @!attribute [rw] name
|
|
248
293
|
# @return [String]
|
|
249
|
-
# Required. The resource name of the
|
|
294
|
+
# Required. The resource name of the
|
|
295
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for
|
|
296
|
+
# signing.
|
|
250
297
|
# @!attribute [rw] digest
|
|
251
298
|
# @return [Google::Cloud::Kms::V1::Digest]
|
|
252
299
|
# Required. The digest of the data to sign. The digest must be produced with
|
|
@@ -254,63 +301,80 @@ module Google
|
|
|
254
301
|
# {Google::Cloud::Kms::V1::CryptoKeyVersion#algorithm algorithm}.
|
|
255
302
|
class AsymmetricSignRequest; end
|
|
256
303
|
|
|
257
|
-
# Request message for
|
|
304
|
+
# Request message for
|
|
305
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}.
|
|
258
306
|
# @!attribute [rw] name
|
|
259
307
|
# @return [String]
|
|
260
|
-
# Required. The resource name of the
|
|
308
|
+
# Required. The resource name of the
|
|
309
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for
|
|
261
310
|
# decryption.
|
|
262
311
|
# @!attribute [rw] ciphertext
|
|
263
312
|
# @return [String]
|
|
264
|
-
# Required. The data encrypted with the named
|
|
265
|
-
# key using
|
|
313
|
+
# Required. The data encrypted with the named
|
|
314
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s public key using
|
|
315
|
+
# OAEP.
|
|
266
316
|
class AsymmetricDecryptRequest; end
|
|
267
317
|
|
|
268
|
-
# Response message for
|
|
318
|
+
# Response message for
|
|
319
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}.
|
|
269
320
|
# @!attribute [rw] plaintext
|
|
270
321
|
# @return [String]
|
|
271
|
-
# The decrypted data originally supplied in
|
|
322
|
+
# The decrypted data originally supplied in
|
|
323
|
+
# {Google::Cloud::Kms::V1::EncryptRequest#plaintext EncryptRequest#plaintext}.
|
|
272
324
|
class DecryptResponse; end
|
|
273
325
|
|
|
274
|
-
# Response message for
|
|
326
|
+
# Response message for
|
|
327
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::Encrypt KeyManagementService::Encrypt}.
|
|
275
328
|
# @!attribute [rw] name
|
|
276
329
|
# @return [String]
|
|
277
|
-
# The resource name of the
|
|
330
|
+
# The resource name of the
|
|
331
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} used in
|
|
332
|
+
# encryption.
|
|
278
333
|
# @!attribute [rw] ciphertext
|
|
279
334
|
# @return [String]
|
|
280
335
|
# The encrypted data.
|
|
281
336
|
class EncryptResponse; end
|
|
282
337
|
|
|
283
|
-
# Response message for
|
|
338
|
+
# Response message for
|
|
339
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}.
|
|
284
340
|
# @!attribute [rw] signature
|
|
285
341
|
# @return [String]
|
|
286
342
|
# The created signature.
|
|
287
343
|
class AsymmetricSignResponse; end
|
|
288
344
|
|
|
289
|
-
# Response message for
|
|
345
|
+
# Response message for
|
|
346
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}.
|
|
290
347
|
# @!attribute [rw] plaintext
|
|
291
348
|
# @return [String]
|
|
292
349
|
# The decrypted data originally encrypted with the matching public key.
|
|
293
350
|
class AsymmetricDecryptResponse; end
|
|
294
351
|
|
|
295
|
-
# Request message for
|
|
352
|
+
# Request message for
|
|
353
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyPrimaryVersion KeyManagementService::UpdateCryptoKeyPrimaryVersion}.
|
|
296
354
|
# @!attribute [rw] name
|
|
297
355
|
# @return [String]
|
|
298
|
-
# The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to
|
|
356
|
+
# The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to
|
|
357
|
+
# update.
|
|
299
358
|
# @!attribute [rw] crypto_key_version_id
|
|
300
359
|
# @return [String]
|
|
301
|
-
# The id of the child
|
|
360
|
+
# The id of the child
|
|
361
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use as primary.
|
|
302
362
|
class UpdateCryptoKeyPrimaryVersionRequest; end
|
|
303
363
|
|
|
304
|
-
# Request message for
|
|
364
|
+
# Request message for
|
|
365
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::DestroyCryptoKeyVersion KeyManagementService::DestroyCryptoKeyVersion}.
|
|
305
366
|
# @!attribute [rw] name
|
|
306
367
|
# @return [String]
|
|
307
|
-
# The resource name of the
|
|
368
|
+
# The resource name of the
|
|
369
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to destroy.
|
|
308
370
|
class DestroyCryptoKeyVersionRequest; end
|
|
309
371
|
|
|
310
|
-
# Request message for
|
|
372
|
+
# Request message for
|
|
373
|
+
# {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion KeyManagementService::RestoreCryptoKeyVersion}.
|
|
311
374
|
# @!attribute [rw] name
|
|
312
375
|
# @return [String]
|
|
313
|
-
# The resource name of the
|
|
376
|
+
# The resource name of the
|
|
377
|
+
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to restore.
|
|
314
378
|
class RestoreCryptoKeyVersionRequest; end
|
|
315
379
|
|
|
316
380
|
# A {Google::Cloud::Kms::V1::Digest Digest} holds a cryptographic message digest.
|
|
@@ -325,12 +389,14 @@ module Google
|
|
|
325
389
|
# A message digest produced with the SHA-512 algorithm.
|
|
326
390
|
class Digest; end
|
|
327
391
|
|
|
328
|
-
# Cloud KMS metadata for the given
|
|
392
|
+
# Cloud KMS metadata for the given
|
|
393
|
+
# {Google::Cloud::Location::Location}.
|
|
329
394
|
# @!attribute [rw] hsm_available
|
|
330
395
|
# @return [true, false]
|
|
331
396
|
# Indicates whether {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with
|
|
332
397
|
# {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}
|
|
333
|
-
# {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} can be created in this
|
|
398
|
+
# {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} can be created in this
|
|
399
|
+
# location.
|
|
334
400
|
class LocationMetadata; end
|
|
335
401
|
end
|
|
336
402
|
end
|