google-cloud-kms-v1 0.1.0 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +6 -6
- data/README.md +5 -1
- data/lib/google/cloud/kms/v1.rb +1 -1
- data/lib/google/cloud/kms/v1/iam_policy.rb +1 -1
- data/lib/google/cloud/kms/v1/iam_policy/client.rb +96 -91
- data/lib/google/cloud/kms/v1/iam_policy/credentials.rb +1 -1
- data/lib/google/cloud/kms/v1/key_management_service.rb +5 -5
- data/lib/google/cloud/kms/v1/key_management_service/client.rb +604 -599
- data/lib/google/cloud/kms/v1/key_management_service/credentials.rb +1 -1
- data/lib/google/cloud/kms/v1/key_management_service/paths.rb +18 -18
- data/lib/google/cloud/kms/v1/service_services_pb.rb +23 -23
- data/lib/google/cloud/kms/v1/version.rb +1 -1
- data/lib/google/iam/v1/iam_policy_services_pb.rb +3 -3
- data/proto_docs/google/api/resource.rb +12 -12
- data/proto_docs/google/cloud/kms/v1/resources.rb +203 -203
- data/proto_docs/google/cloud/kms/v1/service.rb +272 -272
- data/proto_docs/google/iam/v1/iam_policy.rb +15 -15
- data/proto_docs/google/iam/v1/options.rb +3 -3
- data/proto_docs/google/iam/v1/policy.rb +26 -26
- data/proto_docs/google/protobuf/duration.rb +4 -4
- data/proto_docs/google/protobuf/field_mask.rb +3 -3
- data/proto_docs/google/protobuf/timestamp.rb +4 -4
- data/proto_docs/google/type/expr.rb +6 -6
- metadata +35 -7
@@ -24,7 +24,7 @@ module Google
|
|
24
24
|
module V1
|
25
25
|
module KeyManagementService
|
26
26
|
# Credentials for the KeyManagementService API.
|
27
|
-
class Credentials < Google::Auth::Credentials
|
27
|
+
class Credentials < ::Google::Auth::Credentials
|
28
28
|
self.scope = [
|
29
29
|
"https://www.googleapis.com/auth/cloud-platform",
|
30
30
|
"https://www.googleapis.com/auth/cloudkms"
|
@@ -36,11 +36,11 @@ module Google
|
|
36
36
|
# @param key_ring [String]
|
37
37
|
# @param crypto_key [String]
|
38
38
|
#
|
39
|
-
# @return [String]
|
39
|
+
# @return [::String]
|
40
40
|
def crypto_key_path project:, location:, key_ring:, crypto_key:
|
41
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
42
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
43
|
-
raise ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
|
41
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
42
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
43
|
+
raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
|
44
44
|
|
45
45
|
"projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}"
|
46
46
|
end
|
@@ -58,12 +58,12 @@ module Google
|
|
58
58
|
# @param crypto_key [String]
|
59
59
|
# @param crypto_key_version [String]
|
60
60
|
#
|
61
|
-
# @return [String]
|
61
|
+
# @return [::String]
|
62
62
|
def crypto_key_version_path project:, location:, key_ring:, crypto_key:, crypto_key_version:
|
63
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
64
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
65
|
-
raise ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
|
66
|
-
raise ArgumentError, "crypto_key cannot contain /" if crypto_key.to_s.include? "/"
|
63
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
64
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
65
|
+
raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
|
66
|
+
raise ::ArgumentError, "crypto_key cannot contain /" if crypto_key.to_s.include? "/"
|
67
67
|
|
68
68
|
"projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}/cryptoKeyVersions/#{crypto_key_version}"
|
69
69
|
end
|
@@ -80,11 +80,11 @@ module Google
|
|
80
80
|
# @param key_ring [String]
|
81
81
|
# @param import_job [String]
|
82
82
|
#
|
83
|
-
# @return [String]
|
83
|
+
# @return [::String]
|
84
84
|
def import_job_path project:, location:, key_ring:, import_job:
|
85
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
86
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
87
|
-
raise ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
|
85
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
86
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
87
|
+
raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
|
88
88
|
|
89
89
|
"projects/#{project}/locations/#{location}/keyRings/#{key_ring}/importJobs/#{import_job}"
|
90
90
|
end
|
@@ -100,10 +100,10 @@ module Google
|
|
100
100
|
# @param location [String]
|
101
101
|
# @param key_ring [String]
|
102
102
|
#
|
103
|
-
# @return [String]
|
103
|
+
# @return [::String]
|
104
104
|
def key_ring_path project:, location:, key_ring:
|
105
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
106
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
105
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
106
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
107
107
|
|
108
108
|
"projects/#{project}/locations/#{location}/keyRings/#{key_ring}"
|
109
109
|
end
|
@@ -118,9 +118,9 @@ module Google
|
|
118
118
|
# @param project [String]
|
119
119
|
# @param location [String]
|
120
120
|
#
|
121
|
-
# @return [String]
|
121
|
+
# @return [::String]
|
122
122
|
def location_path project:, location:
|
123
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
123
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
124
124
|
|
125
125
|
"projects/#{project}/locations/#{location}"
|
126
126
|
end
|
@@ -45,53 +45,53 @@ module Google
|
|
45
45
|
self.service_name = 'google.cloud.kms.v1.KeyManagementService'
|
46
46
|
|
47
47
|
# Lists [KeyRings][google.cloud.kms.v1.KeyRing].
|
48
|
-
rpc :ListKeyRings, ListKeyRingsRequest, ListKeyRingsResponse
|
48
|
+
rpc :ListKeyRings, Google::Cloud::Kms::V1::ListKeyRingsRequest, Google::Cloud::Kms::V1::ListKeyRingsResponse
|
49
49
|
# Lists [CryptoKeys][google.cloud.kms.v1.CryptoKey].
|
50
|
-
rpc :ListCryptoKeys, ListCryptoKeysRequest, ListCryptoKeysResponse
|
50
|
+
rpc :ListCryptoKeys, Google::Cloud::Kms::V1::ListCryptoKeysRequest, Google::Cloud::Kms::V1::ListCryptoKeysResponse
|
51
51
|
# Lists [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion].
|
52
|
-
rpc :ListCryptoKeyVersions, ListCryptoKeyVersionsRequest, ListCryptoKeyVersionsResponse
|
52
|
+
rpc :ListCryptoKeyVersions, Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest, Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse
|
53
53
|
# Lists [ImportJobs][google.cloud.kms.v1.ImportJob].
|
54
|
-
rpc :ListImportJobs, ListImportJobsRequest, ListImportJobsResponse
|
54
|
+
rpc :ListImportJobs, Google::Cloud::Kms::V1::ListImportJobsRequest, Google::Cloud::Kms::V1::ListImportJobsResponse
|
55
55
|
# Returns metadata for a given [KeyRing][google.cloud.kms.v1.KeyRing].
|
56
|
-
rpc :GetKeyRing, GetKeyRingRequest, KeyRing
|
56
|
+
rpc :GetKeyRing, Google::Cloud::Kms::V1::GetKeyRingRequest, Google::Cloud::Kms::V1::KeyRing
|
57
57
|
# Returns metadata for a given [CryptoKey][google.cloud.kms.v1.CryptoKey], as well as its
|
58
58
|
# [primary][google.cloud.kms.v1.CryptoKey.primary] [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
|
59
|
-
rpc :GetCryptoKey, GetCryptoKeyRequest, CryptoKey
|
59
|
+
rpc :GetCryptoKey, Google::Cloud::Kms::V1::GetCryptoKeyRequest, Google::Cloud::Kms::V1::CryptoKey
|
60
60
|
# Returns metadata for a given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
|
61
|
-
rpc :GetCryptoKeyVersion, GetCryptoKeyVersionRequest, CryptoKeyVersion
|
61
|
+
rpc :GetCryptoKeyVersion, Google::Cloud::Kms::V1::GetCryptoKeyVersionRequest, Google::Cloud::Kms::V1::CryptoKeyVersion
|
62
62
|
# Returns the public key for the given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. The
|
63
63
|
# [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be
|
64
64
|
# [ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN] or
|
65
65
|
# [ASYMMETRIC_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_DECRYPT].
|
66
|
-
rpc :GetPublicKey, GetPublicKeyRequest, PublicKey
|
66
|
+
rpc :GetPublicKey, Google::Cloud::Kms::V1::GetPublicKeyRequest, Google::Cloud::Kms::V1::PublicKey
|
67
67
|
# Returns metadata for a given [ImportJob][google.cloud.kms.v1.ImportJob].
|
68
|
-
rpc :GetImportJob, GetImportJobRequest, ImportJob
|
68
|
+
rpc :GetImportJob, Google::Cloud::Kms::V1::GetImportJobRequest, Google::Cloud::Kms::V1::ImportJob
|
69
69
|
# Create a new [KeyRing][google.cloud.kms.v1.KeyRing] in a given Project and Location.
|
70
|
-
rpc :CreateKeyRing, CreateKeyRingRequest, KeyRing
|
70
|
+
rpc :CreateKeyRing, Google::Cloud::Kms::V1::CreateKeyRingRequest, Google::Cloud::Kms::V1::KeyRing
|
71
71
|
# Create a new [CryptoKey][google.cloud.kms.v1.CryptoKey] within a [KeyRing][google.cloud.kms.v1.KeyRing].
|
72
72
|
#
|
73
73
|
# [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] and
|
74
74
|
# [CryptoKey.version_template.algorithm][google.cloud.kms.v1.CryptoKeyVersionTemplate.algorithm]
|
75
75
|
# are required.
|
76
|
-
rpc :CreateCryptoKey, CreateCryptoKeyRequest, CryptoKey
|
76
|
+
rpc :CreateCryptoKey, Google::Cloud::Kms::V1::CreateCryptoKeyRequest, Google::Cloud::Kms::V1::CryptoKey
|
77
77
|
# Create a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in a [CryptoKey][google.cloud.kms.v1.CryptoKey].
|
78
78
|
#
|
79
79
|
# The server will assign the next sequential id. If unset,
|
80
80
|
# [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to
|
81
81
|
# [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED].
|
82
|
-
rpc :CreateCryptoKeyVersion, CreateCryptoKeyVersionRequest, CryptoKeyVersion
|
82
|
+
rpc :CreateCryptoKeyVersion, Google::Cloud::Kms::V1::CreateCryptoKeyVersionRequest, Google::Cloud::Kms::V1::CryptoKeyVersion
|
83
83
|
# Imports a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] into an existing [CryptoKey][google.cloud.kms.v1.CryptoKey] using the
|
84
84
|
# wrapped key material provided in the request.
|
85
85
|
#
|
86
86
|
# The version ID will be assigned the next sequential id within the
|
87
87
|
# [CryptoKey][google.cloud.kms.v1.CryptoKey].
|
88
|
-
rpc :ImportCryptoKeyVersion, ImportCryptoKeyVersionRequest, CryptoKeyVersion
|
88
|
+
rpc :ImportCryptoKeyVersion, Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest, Google::Cloud::Kms::V1::CryptoKeyVersion
|
89
89
|
# Create a new [ImportJob][google.cloud.kms.v1.ImportJob] within a [KeyRing][google.cloud.kms.v1.KeyRing].
|
90
90
|
#
|
91
91
|
# [ImportJob.import_method][google.cloud.kms.v1.ImportJob.import_method] is required.
|
92
|
-
rpc :CreateImportJob, CreateImportJobRequest, ImportJob
|
92
|
+
rpc :CreateImportJob, Google::Cloud::Kms::V1::CreateImportJobRequest, Google::Cloud::Kms::V1::ImportJob
|
93
93
|
# Update a [CryptoKey][google.cloud.kms.v1.CryptoKey].
|
94
|
-
rpc :UpdateCryptoKey, UpdateCryptoKeyRequest, CryptoKey
|
94
|
+
rpc :UpdateCryptoKey, Google::Cloud::Kms::V1::UpdateCryptoKeyRequest, Google::Cloud::Kms::V1::CryptoKey
|
95
95
|
# Update a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s metadata.
|
96
96
|
#
|
97
97
|
# [state][google.cloud.kms.v1.CryptoKeyVersion.state] may be changed between
|
@@ -99,26 +99,26 @@ module Google
|
|
99
99
|
# [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED] using this
|
100
100
|
# method. See [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion] and [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] to
|
101
101
|
# move between other states.
|
102
|
-
rpc :UpdateCryptoKeyVersion, UpdateCryptoKeyVersionRequest, CryptoKeyVersion
|
102
|
+
rpc :UpdateCryptoKeyVersion, Google::Cloud::Kms::V1::UpdateCryptoKeyVersionRequest, Google::Cloud::Kms::V1::CryptoKeyVersion
|
103
103
|
# Encrypts data, so that it can only be recovered by a call to [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
|
104
104
|
# The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be
|
105
105
|
# [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].
|
106
|
-
rpc :Encrypt, EncryptRequest, EncryptResponse
|
106
|
+
rpc :Encrypt, Google::Cloud::Kms::V1::EncryptRequest, Google::Cloud::Kms::V1::EncryptResponse
|
107
107
|
# Decrypts data that was protected by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose]
|
108
108
|
# must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].
|
109
|
-
rpc :Decrypt, DecryptRequest, DecryptResponse
|
109
|
+
rpc :Decrypt, Google::Cloud::Kms::V1::DecryptRequest, Google::Cloud::Kms::V1::DecryptResponse
|
110
110
|
# Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose]
|
111
111
|
# ASYMMETRIC_SIGN, producing a signature that can be verified with the public
|
112
112
|
# key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
|
113
|
-
rpc :AsymmetricSign, AsymmetricSignRequest, AsymmetricSignResponse
|
113
|
+
rpc :AsymmetricSign, Google::Cloud::Kms::V1::AsymmetricSignRequest, Google::Cloud::Kms::V1::AsymmetricSignResponse
|
114
114
|
# Decrypts data that was encrypted with a public key retrieved from
|
115
115
|
# [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey] corresponding to a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with
|
116
116
|
# [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_DECRYPT.
|
117
|
-
rpc :AsymmetricDecrypt, AsymmetricDecryptRequest, AsymmetricDecryptResponse
|
117
|
+
rpc :AsymmetricDecrypt, Google::Cloud::Kms::V1::AsymmetricDecryptRequest, Google::Cloud::Kms::V1::AsymmetricDecryptResponse
|
118
118
|
# Update the version of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that will be used in [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt].
|
119
119
|
#
|
120
120
|
# Returns an error if called on an asymmetric key.
|
121
|
-
rpc :UpdateCryptoKeyPrimaryVersion, UpdateCryptoKeyPrimaryVersionRequest, CryptoKey
|
121
|
+
rpc :UpdateCryptoKeyPrimaryVersion, Google::Cloud::Kms::V1::UpdateCryptoKeyPrimaryVersionRequest, Google::Cloud::Kms::V1::CryptoKey
|
122
122
|
# Schedule a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] for destruction.
|
123
123
|
#
|
124
124
|
# Upon calling this method, [CryptoKeyVersion.state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to
|
@@ -131,7 +131,7 @@ module Google
|
|
131
131
|
#
|
132
132
|
# Before the [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] is reached,
|
133
133
|
# [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] may be called to reverse the process.
|
134
|
-
rpc :DestroyCryptoKeyVersion, DestroyCryptoKeyVersionRequest, CryptoKeyVersion
|
134
|
+
rpc :DestroyCryptoKeyVersion, Google::Cloud::Kms::V1::DestroyCryptoKeyVersionRequest, Google::Cloud::Kms::V1::CryptoKeyVersion
|
135
135
|
# Restore a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in the
|
136
136
|
# [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED]
|
137
137
|
# state.
|
@@ -139,7 +139,7 @@ module Google
|
|
139
139
|
# Upon restoration of the CryptoKeyVersion, [state][google.cloud.kms.v1.CryptoKeyVersion.state]
|
140
140
|
# will be set to [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED],
|
141
141
|
# and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be cleared.
|
142
|
-
rpc :RestoreCryptoKeyVersion, RestoreCryptoKeyVersionRequest, CryptoKeyVersion
|
142
|
+
rpc :RestoreCryptoKeyVersion, Google::Cloud::Kms::V1::RestoreCryptoKeyVersionRequest, Google::Cloud::Kms::V1::CryptoKeyVersion
|
143
143
|
end
|
144
144
|
|
145
145
|
Stub = Service.rpc_stub_class
|
@@ -59,11 +59,11 @@ module Google
|
|
59
59
|
|
60
60
|
# Sets the access control policy on the specified resource. Replaces any
|
61
61
|
# existing policy.
|
62
|
-
rpc :SetIamPolicy, SetIamPolicyRequest, Policy
|
62
|
+
rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
|
63
63
|
# Gets the access control policy for a resource.
|
64
64
|
# Returns an empty policy if the resource exists and does not have a policy
|
65
65
|
# set.
|
66
|
-
rpc :GetIamPolicy, GetIamPolicyRequest, Policy
|
66
|
+
rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
|
67
67
|
# Returns permissions that a caller has on the specified resource.
|
68
68
|
# If the resource does not exist, this will return an empty set of
|
69
69
|
# permissions, not a NOT_FOUND error.
|
@@ -71,7 +71,7 @@ module Google
|
|
71
71
|
# Note: This operation is designed to be used for building permission-aware
|
72
72
|
# UIs and command-line tools, not for authorization checking. This operation
|
73
73
|
# may "fail open" without warning.
|
74
|
-
rpc :TestIamPermissions, TestIamPermissionsRequest, TestIamPermissionsResponse
|
74
|
+
rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
|
75
75
|
end
|
76
76
|
|
77
77
|
Stub = Service.rpc_stub_class
|
@@ -128,7 +128,7 @@ module Google
|
|
128
128
|
# - pattern: "shelves/{shelf}"
|
129
129
|
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
130
130
|
# @!attribute [rw] type
|
131
|
-
# @return [String]
|
131
|
+
# @return [::String]
|
132
132
|
# The resource type. It must be in the format of
|
133
133
|
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
134
134
|
# singular and must not include version numbers.
|
@@ -140,7 +140,7 @@ module Google
|
|
140
140
|
# should use PascalCase (UpperCamelCase). The maximum number of
|
141
141
|
# characters allowed for the `resource_type_kind` is 100.
|
142
142
|
# @!attribute [rw] pattern
|
143
|
-
# @return [Array
|
143
|
+
# @return [::Array<::String>]
|
144
144
|
# Optional. The relative resource name pattern associated with this resource
|
145
145
|
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
146
146
|
#
|
@@ -161,11 +161,11 @@ module Google
|
|
161
161
|
# the same component name (e.g. "project") refers to IDs of the same
|
162
162
|
# type of resource.
|
163
163
|
# @!attribute [rw] name_field
|
164
|
-
# @return [String]
|
164
|
+
# @return [::String]
|
165
165
|
# Optional. The field on the resource that designates the resource name
|
166
166
|
# field. If omitted, this is assumed to be "name".
|
167
167
|
# @!attribute [rw] history
|
168
|
-
# @return [Google::Api::ResourceDescriptor::History]
|
168
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
169
169
|
# Optional. The historical or future-looking state of the resource pattern.
|
170
170
|
#
|
171
171
|
# Example:
|
@@ -182,19 +182,19 @@ module Google
|
|
182
182
|
# };
|
183
183
|
# }
|
184
184
|
# @!attribute [rw] plural
|
185
|
-
# @return [String]
|
185
|
+
# @return [::String]
|
186
186
|
# The plural name used in the resource name, such as 'projects' for
|
187
187
|
# the name of 'projects/\\{project}'. It is the same concept of the `plural`
|
188
188
|
# field in k8s CRD spec
|
189
189
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
190
190
|
# @!attribute [rw] singular
|
191
|
-
# @return [String]
|
191
|
+
# @return [::String]
|
192
192
|
# The same concept of the `singular` field in k8s CRD spec
|
193
193
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
194
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
195
195
|
class ResourceDescriptor
|
196
|
-
include Google::Protobuf::MessageExts
|
197
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
196
|
+
include ::Google::Protobuf::MessageExts
|
197
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
198
198
|
|
199
199
|
# A description of the historical or future-looking state of the
|
200
200
|
# resource pattern.
|
@@ -216,7 +216,7 @@ module Google
|
|
216
216
|
# Defines a proto annotation that describes a string field that refers to
|
217
217
|
# an API resource.
|
218
218
|
# @!attribute [rw] type
|
219
|
-
# @return [String]
|
219
|
+
# @return [::String]
|
220
220
|
# The resource type that the annotated field references.
|
221
221
|
#
|
222
222
|
# Example:
|
@@ -227,7 +227,7 @@ module Google
|
|
227
227
|
# }];
|
228
228
|
# }
|
229
229
|
# @!attribute [rw] child_type
|
230
|
-
# @return [String]
|
230
|
+
# @return [::String]
|
231
231
|
# The resource type of a child collection that the annotated field
|
232
232
|
# references. This is useful for annotating the `parent` field that
|
233
233
|
# doesn't have a fixed resource type.
|
@@ -240,8 +240,8 @@ module Google
|
|
240
240
|
# };
|
241
241
|
# }
|
242
242
|
class ResourceReference
|
243
|
-
include Google::Protobuf::MessageExts
|
244
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
243
|
+
include ::Google::Protobuf::MessageExts
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
245
245
|
end
|
246
246
|
end
|
247
247
|
end
|
@@ -21,154 +21,154 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Kms
|
23
23
|
module V1
|
24
|
-
# A {Google::Cloud::Kms::V1::KeyRing KeyRing} is a toplevel logical grouping of {Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
|
24
|
+
# A {::Google::Cloud::Kms::V1::KeyRing KeyRing} is a toplevel logical grouping of {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys}.
|
25
25
|
# @!attribute [r] name
|
26
|
-
# @return [String]
|
27
|
-
# Output only. The resource name for the {Google::Cloud::Kms::V1::KeyRing KeyRing} in the format
|
26
|
+
# @return [::String]
|
27
|
+
# Output only. The resource name for the {::Google::Cloud::Kms::V1::KeyRing KeyRing} in the format
|
28
28
|
# `projects/*/locations/*/keyRings/*`.
|
29
29
|
# @!attribute [r] create_time
|
30
|
-
# @return [Google::Protobuf::Timestamp]
|
31
|
-
# Output only. The time at which this {Google::Cloud::Kms::V1::KeyRing KeyRing} was created.
|
30
|
+
# @return [::Google::Protobuf::Timestamp]
|
31
|
+
# Output only. The time at which this {::Google::Cloud::Kms::V1::KeyRing KeyRing} was created.
|
32
32
|
class KeyRing
|
33
|
-
include Google::Protobuf::MessageExts
|
34
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
include ::Google::Protobuf::MessageExts
|
34
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
35
35
|
end
|
36
36
|
|
37
|
-
# A {Google::Cloud::Kms::V1::CryptoKey CryptoKey} represents a logical key that can be used for cryptographic
|
37
|
+
# A {::Google::Cloud::Kms::V1::CryptoKey CryptoKey} represents a logical key that can be used for cryptographic
|
38
38
|
# operations.
|
39
39
|
#
|
40
|
-
# A {Google::Cloud::Kms::V1::CryptoKey CryptoKey} is made up of one or more {Google::Cloud::Kms::V1::CryptoKeyVersion versions}, which
|
40
|
+
# A {::Google::Cloud::Kms::V1::CryptoKey CryptoKey} is made up of one or more {::Google::Cloud::Kms::V1::CryptoKeyVersion versions}, which
|
41
41
|
# represent the actual key material used in cryptographic operations.
|
42
42
|
# @!attribute [r] name
|
43
|
-
# @return [String]
|
44
|
-
# Output only. The resource name for this {Google::Cloud::Kms::V1::CryptoKey CryptoKey} in the format
|
43
|
+
# @return [::String]
|
44
|
+
# Output only. The resource name for this {::Google::Cloud::Kms::V1::CryptoKey CryptoKey} in the format
|
45
45
|
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
|
46
46
|
# @!attribute [r] primary
|
47
|
-
# @return [Google::Cloud::Kms::V1::CryptoKeyVersion]
|
48
|
-
# Output only. A copy of the "primary" {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} that will be used
|
49
|
-
# by {Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} when this {Google::Cloud::Kms::V1::CryptoKey CryptoKey} is given
|
50
|
-
# in {Google::Cloud::Kms::V1::EncryptRequest#name EncryptRequest.name}.
|
47
|
+
# @return [::Google::Cloud::Kms::V1::CryptoKeyVersion]
|
48
|
+
# Output only. A copy of the "primary" {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} that will be used
|
49
|
+
# by {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} when this {::Google::Cloud::Kms::V1::CryptoKey CryptoKey} is given
|
50
|
+
# in {::Google::Cloud::Kms::V1::EncryptRequest#name EncryptRequest.name}.
|
51
51
|
#
|
52
|
-
# The {Google::Cloud::Kms::V1::CryptoKey CryptoKey}'s primary version can be updated via
|
53
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#update_crypto_key_primary_version UpdateCryptoKeyPrimaryVersion}.
|
52
|
+
# The {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}'s primary version can be updated via
|
53
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#update_crypto_key_primary_version UpdateCryptoKeyPrimaryVersion}.
|
54
54
|
#
|
55
|
-
# Keys with {Google::Cloud::Kms::V1::CryptoKey#purpose purpose}
|
56
|
-
# {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT} may have a
|
55
|
+
# Keys with {::Google::Cloud::Kms::V1::CryptoKey#purpose purpose}
|
56
|
+
# {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT} may have a
|
57
57
|
# primary. For other keys, this field will be omitted.
|
58
58
|
# @!attribute [rw] purpose
|
59
|
-
# @return [Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose]
|
60
|
-
# Immutable. The immutable purpose of this {Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
|
59
|
+
# @return [::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose]
|
60
|
+
# Immutable. The immutable purpose of this {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
|
61
61
|
# @!attribute [r] create_time
|
62
|
-
# @return [Google::Protobuf::Timestamp]
|
63
|
-
# Output only. The time at which this {Google::Cloud::Kms::V1::CryptoKey CryptoKey} was created.
|
62
|
+
# @return [::Google::Protobuf::Timestamp]
|
63
|
+
# Output only. The time at which this {::Google::Cloud::Kms::V1::CryptoKey CryptoKey} was created.
|
64
64
|
# @!attribute [rw] next_rotation_time
|
65
|
-
# @return [Google::Protobuf::Timestamp]
|
66
|
-
# At {Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time}, the Key Management Service will automatically:
|
65
|
+
# @return [::Google::Protobuf::Timestamp]
|
66
|
+
# At {::Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time}, the Key Management Service will automatically:
|
67
67
|
#
|
68
|
-
# 1. Create a new version of this {Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
|
68
|
+
# 1. Create a new version of this {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
|
69
69
|
# 2. Mark the new version as primary.
|
70
70
|
#
|
71
71
|
# Key rotations performed manually via
|
72
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key_version CreateCryptoKeyVersion} and
|
73
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#update_crypto_key_primary_version UpdateCryptoKeyPrimaryVersion}
|
74
|
-
# do not affect {Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time}.
|
72
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key_version CreateCryptoKeyVersion} and
|
73
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#update_crypto_key_primary_version UpdateCryptoKeyPrimaryVersion}
|
74
|
+
# do not affect {::Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time}.
|
75
75
|
#
|
76
|
-
# Keys with {Google::Cloud::Kms::V1::CryptoKey#purpose purpose}
|
77
|
-
# {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT} support
|
76
|
+
# Keys with {::Google::Cloud::Kms::V1::CryptoKey#purpose purpose}
|
77
|
+
# {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT} support
|
78
78
|
# automatic rotation. For other keys, this field must be omitted.
|
79
79
|
# @!attribute [rw] rotation_period
|
80
|
-
# @return [Google::Protobuf::Duration]
|
81
|
-
# {Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time} will be advanced by this period when the service
|
80
|
+
# @return [::Google::Protobuf::Duration]
|
81
|
+
# {::Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time} will be advanced by this period when the service
|
82
82
|
# automatically rotates a key. Must be at least 24 hours and at most
|
83
83
|
# 876,000 hours.
|
84
84
|
#
|
85
|
-
# If {Google::Cloud::Kms::V1::CryptoKey#rotation_period rotation_period} is set, {Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time} must also be set.
|
85
|
+
# If {::Google::Cloud::Kms::V1::CryptoKey#rotation_period rotation_period} is set, {::Google::Cloud::Kms::V1::CryptoKey#next_rotation_time next_rotation_time} must also be set.
|
86
86
|
#
|
87
|
-
# Keys with {Google::Cloud::Kms::V1::CryptoKey#purpose purpose}
|
88
|
-
# {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT} support
|
87
|
+
# Keys with {::Google::Cloud::Kms::V1::CryptoKey#purpose purpose}
|
88
|
+
# {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT} support
|
89
89
|
# automatic rotation. For other keys, this field must be omitted.
|
90
90
|
# @!attribute [rw] version_template
|
91
|
-
# @return [Google::Cloud::Kms::V1::CryptoKeyVersionTemplate]
|
92
|
-
# A template describing settings for new {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} instances.
|
93
|
-
# The properties of new {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} instances created by either
|
94
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key_version CreateCryptoKeyVersion} or
|
91
|
+
# @return [::Google::Cloud::Kms::V1::CryptoKeyVersionTemplate]
|
92
|
+
# A template describing settings for new {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} instances.
|
93
|
+
# The properties of new {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} instances created by either
|
94
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key_version CreateCryptoKeyVersion} or
|
95
95
|
# auto-rotation are controlled by this template.
|
96
96
|
# @!attribute [rw] labels
|
97
|
-
# @return [Google::Protobuf::Map{String => String}]
|
97
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
98
98
|
# Labels with user-defined metadata. For more information, see
|
99
|
-
# [Labeling Keys](/kms/docs/labeling-keys).
|
99
|
+
# [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
|
100
100
|
class CryptoKey
|
101
|
-
include Google::Protobuf::MessageExts
|
102
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
101
|
+
include ::Google::Protobuf::MessageExts
|
102
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
103
103
|
|
104
104
|
# @!attribute [rw] key
|
105
|
-
# @return [String]
|
105
|
+
# @return [::String]
|
106
106
|
# @!attribute [rw] value
|
107
|
-
# @return [String]
|
107
|
+
# @return [::String]
|
108
108
|
class LabelsEntry
|
109
|
-
include Google::Protobuf::MessageExts
|
110
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
109
|
+
include ::Google::Protobuf::MessageExts
|
110
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
111
111
|
end
|
112
112
|
|
113
|
-
# {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a
|
114
|
-
# {Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by
|
113
|
+
# {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a
|
114
|
+
# {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by
|
115
115
|
# its purpose. For more information, see
|
116
116
|
# [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes).
|
117
117
|
module CryptoKeyPurpose
|
118
118
|
# Not specified.
|
119
119
|
CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0
|
120
120
|
|
121
|
-
# {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with
|
122
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and
|
123
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}.
|
121
|
+
# {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with
|
122
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#encrypt Encrypt} and
|
123
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}.
|
124
124
|
ENCRYPT_DECRYPT = 1
|
125
125
|
|
126
|
-
# {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with
|
127
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and
|
128
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}.
|
126
|
+
# {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with
|
127
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and
|
128
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}.
|
129
129
|
ASYMMETRIC_SIGN = 5
|
130
130
|
|
131
|
-
# {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with
|
132
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and
|
133
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}.
|
131
|
+
# {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with
|
132
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and
|
133
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}.
|
134
134
|
ASYMMETRIC_DECRYPT = 6
|
135
135
|
end
|
136
136
|
end
|
137
137
|
|
138
|
-
# A {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate CryptoKeyVersionTemplate} specifies the properties to use when creating
|
139
|
-
# a new {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, either manually with
|
140
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key_version CreateCryptoKeyVersion} or
|
138
|
+
# A {::Google::Cloud::Kms::V1::CryptoKeyVersionTemplate CryptoKeyVersionTemplate} specifies the properties to use when creating
|
139
|
+
# a new {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, either manually with
|
140
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key_version CreateCryptoKeyVersion} or
|
141
141
|
# automatically as a result of auto-rotation.
|
142
142
|
# @!attribute [rw] protection_level
|
143
|
-
# @return [Google::Cloud::Kms::V1::ProtectionLevel]
|
144
|
-
# {Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevel} to use when creating a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} based on
|
145
|
-
# this template. Immutable. Defaults to {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE}.
|
143
|
+
# @return [::Google::Cloud::Kms::V1::ProtectionLevel]
|
144
|
+
# {::Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevel} to use when creating a {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} based on
|
145
|
+
# this template. Immutable. Defaults to {::Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE}.
|
146
146
|
# @!attribute [rw] algorithm
|
147
|
-
# @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm]
|
148
|
-
# Required. {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm Algorithm} to use
|
149
|
-
# when creating a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} based on this template.
|
147
|
+
# @return [::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm]
|
148
|
+
# Required. {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm Algorithm} to use
|
149
|
+
# when creating a {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} based on this template.
|
150
150
|
#
|
151
151
|
# For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
|
152
|
-
# this field is omitted and {Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose} is
|
153
|
-
# {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT}.
|
152
|
+
# this field is omitted and {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose} is
|
153
|
+
# {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT}.
|
154
154
|
class CryptoKeyVersionTemplate
|
155
|
-
include Google::Protobuf::MessageExts
|
156
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
155
|
+
include ::Google::Protobuf::MessageExts
|
156
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
157
157
|
end
|
158
158
|
|
159
159
|
# Contains an HSM-generated attestation about a key operation. For more
|
160
160
|
# information, see [Verifying attestations]
|
161
161
|
# (https://cloud.google.com/kms/docs/attest-key).
|
162
162
|
# @!attribute [r] format
|
163
|
-
# @return [Google::Cloud::Kms::V1::KeyOperationAttestation::AttestationFormat]
|
163
|
+
# @return [::Google::Cloud::Kms::V1::KeyOperationAttestation::AttestationFormat]
|
164
164
|
# Output only. The format of the attestation data.
|
165
165
|
# @!attribute [r] content
|
166
|
-
# @return [String]
|
166
|
+
# @return [::String]
|
167
167
|
# Output only. The attestation data provided by the HSM when the key
|
168
168
|
# operation was performed.
|
169
169
|
class KeyOperationAttestation
|
170
|
-
include Google::Protobuf::MessageExts
|
171
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
170
|
+
include ::Google::Protobuf::MessageExts
|
171
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
172
172
|
|
173
173
|
# Attestation formats provided by the HSM.
|
174
174
|
module AttestationFormat
|
@@ -185,105 +185,105 @@ module Google
|
|
185
185
|
end
|
186
186
|
end
|
187
187
|
|
188
|
-
# A {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} represents an individual cryptographic key, and the
|
188
|
+
# A {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} represents an individual cryptographic key, and the
|
189
189
|
# associated key material.
|
190
190
|
#
|
191
|
-
# An {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} version can be
|
191
|
+
# An {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} version can be
|
192
192
|
# used for cryptographic operations.
|
193
193
|
#
|
194
194
|
# For security reasons, the raw cryptographic key material represented by a
|
195
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} can never be viewed or exported. It can only be used to
|
195
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} can never be viewed or exported. It can only be used to
|
196
196
|
# encrypt, decrypt, or sign data when an authorized user or application invokes
|
197
197
|
# Cloud KMS.
|
198
198
|
# @!attribute [r] name
|
199
|
-
# @return [String]
|
200
|
-
# Output only. The resource name for this {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} in the format
|
199
|
+
# @return [::String]
|
200
|
+
# Output only. The resource name for this {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} in the format
|
201
201
|
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
|
202
202
|
# @!attribute [rw] state
|
203
|
-
# @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState]
|
204
|
-
# The current state of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}.
|
203
|
+
# @return [::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState]
|
204
|
+
# The current state of the {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}.
|
205
205
|
# @!attribute [r] protection_level
|
206
|
-
# @return [Google::Cloud::Kms::V1::ProtectionLevel]
|
207
|
-
# Output only. The {Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevel} describing how crypto operations are
|
208
|
-
# performed with this {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}.
|
206
|
+
# @return [::Google::Cloud::Kms::V1::ProtectionLevel]
|
207
|
+
# Output only. The {::Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevel} describing how crypto operations are
|
208
|
+
# performed with this {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}.
|
209
209
|
# @!attribute [r] algorithm
|
210
|
-
# @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm]
|
211
|
-
# Output only. The {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm CryptoKeyVersionAlgorithm} that this
|
212
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} supports.
|
210
|
+
# @return [::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm]
|
211
|
+
# Output only. The {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm CryptoKeyVersionAlgorithm} that this
|
212
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} supports.
|
213
213
|
# @!attribute [r] attestation
|
214
|
-
# @return [Google::Cloud::Kms::V1::KeyOperationAttestation]
|
214
|
+
# @return [::Google::Cloud::Kms::V1::KeyOperationAttestation]
|
215
215
|
# Output only. Statement that was generated and signed by the HSM at key
|
216
216
|
# creation time. Use this statement to verify attributes of the key as stored
|
217
217
|
# on the HSM, independently of Google. Only provided for key versions with
|
218
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion#protection_level protection_level} {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM}.
|
218
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion#protection_level protection_level} {::Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM}.
|
219
219
|
# @!attribute [r] create_time
|
220
|
-
# @return [Google::Protobuf::Timestamp]
|
221
|
-
# Output only. The time at which this {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} was created.
|
220
|
+
# @return [::Google::Protobuf::Timestamp]
|
221
|
+
# Output only. The time at which this {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} was created.
|
222
222
|
# @!attribute [r] generate_time
|
223
|
-
# @return [Google::Protobuf::Timestamp]
|
224
|
-
# Output only. The time this {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s key material was
|
223
|
+
# @return [::Google::Protobuf::Timestamp]
|
224
|
+
# Output only. The time this {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s key material was
|
225
225
|
# generated.
|
226
226
|
# @!attribute [r] destroy_time
|
227
|
-
# @return [Google::Protobuf::Timestamp]
|
228
|
-
# Output only. The time this {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s key material is scheduled
|
229
|
-
# for destruction. Only present if {Google::Cloud::Kms::V1::CryptoKeyVersion#state state} is
|
230
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DESTROY_SCHEDULED DESTROY_SCHEDULED}.
|
227
|
+
# @return [::Google::Protobuf::Timestamp]
|
228
|
+
# Output only. The time this {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s key material is scheduled
|
229
|
+
# for destruction. Only present if {::Google::Cloud::Kms::V1::CryptoKeyVersion#state state} is
|
230
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DESTROY_SCHEDULED DESTROY_SCHEDULED}.
|
231
231
|
# @!attribute [r] destroy_event_time
|
232
|
-
# @return [Google::Protobuf::Timestamp]
|
232
|
+
# @return [::Google::Protobuf::Timestamp]
|
233
233
|
# Output only. The time this CryptoKeyVersion's key material was
|
234
|
-
# destroyed. Only present if {Google::Cloud::Kms::V1::CryptoKeyVersion#state state} is
|
235
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DESTROYED DESTROYED}.
|
234
|
+
# destroyed. Only present if {::Google::Cloud::Kms::V1::CryptoKeyVersion#state state} is
|
235
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DESTROYED DESTROYED}.
|
236
236
|
# @!attribute [r] import_job
|
237
|
-
# @return [String]
|
238
|
-
# Output only. The name of the {Google::Cloud::Kms::V1::ImportJob ImportJob} used to import this
|
239
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}. Only present if the underlying key material was
|
237
|
+
# @return [::String]
|
238
|
+
# Output only. The name of the {::Google::Cloud::Kms::V1::ImportJob ImportJob} used to import this
|
239
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}. Only present if the underlying key material was
|
240
240
|
# imported.
|
241
241
|
# @!attribute [r] import_time
|
242
|
-
# @return [Google::Protobuf::Timestamp]
|
243
|
-
# Output only. The time at which this {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s key material
|
242
|
+
# @return [::Google::Protobuf::Timestamp]
|
243
|
+
# Output only. The time at which this {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s key material
|
244
244
|
# was imported.
|
245
245
|
# @!attribute [r] import_failure_reason
|
246
|
-
# @return [String]
|
246
|
+
# @return [::String]
|
247
247
|
# Output only. The root cause of an import failure. Only present if
|
248
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion#state state} is
|
249
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::IMPORT_FAILED IMPORT_FAILED}.
|
248
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion#state state} is
|
249
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::IMPORT_FAILED IMPORT_FAILED}.
|
250
250
|
# @!attribute [rw] external_protection_level_options
|
251
|
-
# @return [Google::Cloud::Kms::V1::ExternalProtectionLevelOptions]
|
251
|
+
# @return [::Google::Cloud::Kms::V1::ExternalProtectionLevelOptions]
|
252
252
|
# ExternalProtectionLevelOptions stores a group of additional fields for
|
253
|
-
# configuring a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} that are specific to the
|
254
|
-
# {Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL EXTERNAL} protection level.
|
253
|
+
# configuring a {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} that are specific to the
|
254
|
+
# {::Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL EXTERNAL} protection level.
|
255
255
|
class CryptoKeyVersion
|
256
|
-
include Google::Protobuf::MessageExts
|
257
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
256
|
+
include ::Google::Protobuf::MessageExts
|
257
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
258
258
|
|
259
|
-
# The algorithm of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, indicating what
|
259
|
+
# The algorithm of the {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, indicating what
|
260
260
|
# parameters must be used for each cryptographic operation.
|
261
261
|
#
|
262
262
|
# The
|
263
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm::GOOGLE_SYMMETRIC_ENCRYPTION GOOGLE_SYMMETRIC_ENCRYPTION}
|
264
|
-
# algorithm is usable with {Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
|
265
|
-
# {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT}.
|
263
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm::GOOGLE_SYMMETRIC_ENCRYPTION GOOGLE_SYMMETRIC_ENCRYPTION}
|
264
|
+
# algorithm is usable with {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
|
265
|
+
# {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT}.
|
266
266
|
#
|
267
|
-
# Algorithms beginning with "RSA_SIGN_" are usable with {Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
|
268
|
-
# {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_SIGN ASYMMETRIC_SIGN}.
|
267
|
+
# Algorithms beginning with "RSA_SIGN_" are usable with {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
|
268
|
+
# {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_SIGN ASYMMETRIC_SIGN}.
|
269
269
|
#
|
270
270
|
# The fields in the name after "RSA_SIGN_" correspond to the following
|
271
271
|
# parameters: padding algorithm, modulus bit length, and digest algorithm.
|
272
272
|
#
|
273
273
|
# For PSS, the salt length used is equal to the length of digest
|
274
274
|
# algorithm. For example,
|
275
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm::RSA_SIGN_PSS_2048_SHA256 RSA_SIGN_PSS_2048_SHA256}
|
275
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm::RSA_SIGN_PSS_2048_SHA256 RSA_SIGN_PSS_2048_SHA256}
|
276
276
|
# will use PSS with a salt length of 256 bits or 32 bytes.
|
277
277
|
#
|
278
278
|
# Algorithms beginning with "RSA_DECRYPT_" are usable with
|
279
|
-
# {Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
|
280
|
-
# {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_DECRYPT ASYMMETRIC_DECRYPT}.
|
279
|
+
# {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
|
280
|
+
# {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_DECRYPT ASYMMETRIC_DECRYPT}.
|
281
281
|
#
|
282
282
|
# The fields in the name after "RSA_DECRYPT_" correspond to the following
|
283
283
|
# parameters: padding algorithm, modulus bit length, and digest algorithm.
|
284
284
|
#
|
285
|
-
# Algorithms beginning with "EC_SIGN_" are usable with {Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
|
286
|
-
# {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_SIGN ASYMMETRIC_SIGN}.
|
285
|
+
# Algorithms beginning with "EC_SIGN_" are usable with {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
|
286
|
+
# {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_SIGN ASYMMETRIC_SIGN}.
|
287
287
|
#
|
288
288
|
# The fields in the name after "EC_SIGN_" correspond to the following
|
289
289
|
# parameters: elliptic curve, digest algorithm.
|
@@ -343,21 +343,21 @@ module Google
|
|
343
343
|
EXTERNAL_SYMMETRIC_ENCRYPTION = 18
|
344
344
|
end
|
345
345
|
|
346
|
-
# The state of a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, indicating if it can be used.
|
346
|
+
# The state of a {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, indicating if it can be used.
|
347
347
|
module CryptoKeyVersionState
|
348
348
|
# Not specified.
|
349
349
|
CRYPTO_KEY_VERSION_STATE_UNSPECIFIED = 0
|
350
350
|
|
351
351
|
# This version is still being generated. It may not be used, enabled,
|
352
352
|
# disabled, or destroyed yet. Cloud KMS will automatically mark this
|
353
|
-
# version {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} as soon as the version is ready.
|
353
|
+
# version {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} as soon as the version is ready.
|
354
354
|
PENDING_GENERATION = 5
|
355
355
|
|
356
356
|
# This version may be used for cryptographic operations.
|
357
357
|
ENABLED = 1
|
358
358
|
|
359
359
|
# This version may not be used, but the key material is still available,
|
360
|
-
# and the version can be placed back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} state.
|
360
|
+
# and the version can be placed back into the {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} state.
|
361
361
|
DISABLED = 2
|
362
362
|
|
363
363
|
# This version is destroyed, and the key material is no longer stored.
|
@@ -366,145 +366,145 @@ module Google
|
|
366
366
|
|
367
367
|
# This version is scheduled for destruction, and will be destroyed soon.
|
368
368
|
# Call
|
369
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#restore_crypto_key_version RestoreCryptoKeyVersion}
|
370
|
-
# to put it back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DISABLED DISABLED} state.
|
369
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#restore_crypto_key_version RestoreCryptoKeyVersion}
|
370
|
+
# to put it back into the {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DISABLED DISABLED} state.
|
371
371
|
DESTROY_SCHEDULED = 4
|
372
372
|
|
373
373
|
# This version is still being imported. It may not be used, enabled,
|
374
374
|
# disabled, or destroyed yet. Cloud KMS will automatically mark this
|
375
|
-
# version {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} as soon as the version is ready.
|
375
|
+
# version {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} as soon as the version is ready.
|
376
376
|
PENDING_IMPORT = 6
|
377
377
|
|
378
378
|
# This version was not imported successfully. It may not be used, enabled,
|
379
379
|
# disabled, or destroyed. The submitted key material has been discarded.
|
380
380
|
# Additional details can be found in
|
381
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion#import_failure_reason CryptoKeyVersion.import_failure_reason}.
|
381
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion#import_failure_reason CryptoKeyVersion.import_failure_reason}.
|
382
382
|
IMPORT_FAILED = 7
|
383
383
|
end
|
384
384
|
|
385
|
-
# A view for {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}s. Controls the level of detail returned
|
386
|
-
# for {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} in
|
387
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#list_crypto_key_versions KeyManagementService.ListCryptoKeyVersions} and
|
388
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#list_crypto_keys KeyManagementService.ListCryptoKeys}.
|
385
|
+
# A view for {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}s. Controls the level of detail returned
|
386
|
+
# for {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} in
|
387
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#list_crypto_key_versions KeyManagementService.ListCryptoKeyVersions} and
|
388
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#list_crypto_keys KeyManagementService.ListCryptoKeys}.
|
389
389
|
module CryptoKeyVersionView
|
390
|
-
# Default view for each {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}. Does not include
|
391
|
-
# the {Google::Cloud::Kms::V1::CryptoKeyVersion#attestation attestation} field.
|
390
|
+
# Default view for each {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}. Does not include
|
391
|
+
# the {::Google::Cloud::Kms::V1::CryptoKeyVersion#attestation attestation} field.
|
392
392
|
CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED = 0
|
393
393
|
|
394
|
-
# Provides all fields in each {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, including the
|
395
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion#attestation attestation}.
|
394
|
+
# Provides all fields in each {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, including the
|
395
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion#attestation attestation}.
|
396
396
|
FULL = 1
|
397
397
|
end
|
398
398
|
end
|
399
399
|
|
400
|
-
# The public key for a given {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}. Obtained via
|
401
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}.
|
400
|
+
# The public key for a given {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}. Obtained via
|
401
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}.
|
402
402
|
# @!attribute [rw] pem
|
403
|
-
# @return [String]
|
403
|
+
# @return [::String]
|
404
404
|
# The public key, encoded in PEM format. For more information, see the
|
405
405
|
# [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for
|
406
406
|
# [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and
|
407
407
|
# [Textual Encoding of Subject Public Key Info]
|
408
408
|
# (https://tools.ietf.org/html/rfc7468#section-13).
|
409
409
|
# @!attribute [rw] algorithm
|
410
|
-
# @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm]
|
411
|
-
# The {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm Algorithm} associated
|
410
|
+
# @return [::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm]
|
411
|
+
# The {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm Algorithm} associated
|
412
412
|
# with this key.
|
413
413
|
class PublicKey
|
414
|
-
include Google::Protobuf::MessageExts
|
415
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
414
|
+
include ::Google::Protobuf::MessageExts
|
415
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
416
416
|
end
|
417
417
|
|
418
|
-
# An {Google::Cloud::Kms::V1::ImportJob ImportJob} can be used to create {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} and
|
419
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} using pre-existing key material,
|
418
|
+
# An {::Google::Cloud::Kms::V1::ImportJob ImportJob} can be used to create {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} and
|
419
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} using pre-existing key material,
|
420
420
|
# generated outside of Cloud KMS.
|
421
421
|
#
|
422
|
-
# When an {Google::Cloud::Kms::V1::ImportJob ImportJob} is created, Cloud KMS will generate a "wrapping key",
|
422
|
+
# When an {::Google::Cloud::Kms::V1::ImportJob ImportJob} is created, Cloud KMS will generate a "wrapping key",
|
423
423
|
# which is a public/private key pair. You use the wrapping key to encrypt (also
|
424
424
|
# known as wrap) the pre-existing key material to protect it during the import
|
425
425
|
# process. The nature of the wrapping key depends on the choice of
|
426
|
-
# {Google::Cloud::Kms::V1::ImportJob#import_method import_method}. When the wrapping key generation
|
427
|
-
# is complete, the {Google::Cloud::Kms::V1::ImportJob#state state} will be set to
|
428
|
-
# {Google::Cloud::Kms::V1::ImportJob::ImportJobState::ACTIVE ACTIVE} and the {Google::Cloud::Kms::V1::ImportJob#public_key public_key}
|
426
|
+
# {::Google::Cloud::Kms::V1::ImportJob#import_method import_method}. When the wrapping key generation
|
427
|
+
# is complete, the {::Google::Cloud::Kms::V1::ImportJob#state state} will be set to
|
428
|
+
# {::Google::Cloud::Kms::V1::ImportJob::ImportJobState::ACTIVE ACTIVE} and the {::Google::Cloud::Kms::V1::ImportJob#public_key public_key}
|
429
429
|
# can be fetched. The fetched public key can then be used to wrap your
|
430
430
|
# pre-existing key material.
|
431
431
|
#
|
432
432
|
# Once the key material is wrapped, it can be imported into a new
|
433
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} in an existing {Google::Cloud::Kms::V1::CryptoKey CryptoKey} by calling
|
434
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#import_crypto_key_version ImportCryptoKeyVersion}.
|
435
|
-
# Multiple {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} can be imported with a single
|
436
|
-
# {Google::Cloud::Kms::V1::ImportJob ImportJob}. Cloud KMS uses the private key portion of the wrapping key to
|
433
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} in an existing {::Google::Cloud::Kms::V1::CryptoKey CryptoKey} by calling
|
434
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#import_crypto_key_version ImportCryptoKeyVersion}.
|
435
|
+
# Multiple {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} can be imported with a single
|
436
|
+
# {::Google::Cloud::Kms::V1::ImportJob ImportJob}. Cloud KMS uses the private key portion of the wrapping key to
|
437
437
|
# unwrap the key material. Only Cloud KMS has access to the private key.
|
438
438
|
#
|
439
|
-
# An {Google::Cloud::Kms::V1::ImportJob ImportJob} expires 3 days after it is created. Once expired, Cloud KMS
|
439
|
+
# An {::Google::Cloud::Kms::V1::ImportJob ImportJob} expires 3 days after it is created. Once expired, Cloud KMS
|
440
440
|
# will no longer be able to import or unwrap any key material that was wrapped
|
441
|
-
# with the {Google::Cloud::Kms::V1::ImportJob ImportJob}'s public key.
|
441
|
+
# with the {::Google::Cloud::Kms::V1::ImportJob ImportJob}'s public key.
|
442
442
|
#
|
443
443
|
# For more information, see
|
444
444
|
# [Importing a key](https://cloud.google.com/kms/docs/importing-a-key).
|
445
445
|
# @!attribute [r] name
|
446
|
-
# @return [String]
|
447
|
-
# Output only. The resource name for this {Google::Cloud::Kms::V1::ImportJob ImportJob} in the format
|
446
|
+
# @return [::String]
|
447
|
+
# Output only. The resource name for this {::Google::Cloud::Kms::V1::ImportJob ImportJob} in the format
|
448
448
|
# `projects/*/locations/*/keyRings/*/importJobs/*`.
|
449
449
|
# @!attribute [rw] import_method
|
450
|
-
# @return [Google::Cloud::Kms::V1::ImportJob::ImportMethod]
|
450
|
+
# @return [::Google::Cloud::Kms::V1::ImportJob::ImportMethod]
|
451
451
|
# Required. Immutable. The wrapping method to be used for incoming key material.
|
452
452
|
# @!attribute [rw] protection_level
|
453
|
-
# @return [Google::Cloud::Kms::V1::ProtectionLevel]
|
454
|
-
# Required. Immutable. The protection level of the {Google::Cloud::Kms::V1::ImportJob ImportJob}. This must match the
|
455
|
-
# {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level} of the
|
456
|
-
# {Google::Cloud::Kms::V1::CryptoKey#version_template version_template} on the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} you
|
453
|
+
# @return [::Google::Cloud::Kms::V1::ProtectionLevel]
|
454
|
+
# Required. Immutable. The protection level of the {::Google::Cloud::Kms::V1::ImportJob ImportJob}. This must match the
|
455
|
+
# {::Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level} of the
|
456
|
+
# {::Google::Cloud::Kms::V1::CryptoKey#version_template version_template} on the {::Google::Cloud::Kms::V1::CryptoKey CryptoKey} you
|
457
457
|
# attempt to import into.
|
458
458
|
# @!attribute [r] create_time
|
459
|
-
# @return [Google::Protobuf::Timestamp]
|
460
|
-
# Output only. The time at which this {Google::Cloud::Kms::V1::ImportJob ImportJob} was created.
|
459
|
+
# @return [::Google::Protobuf::Timestamp]
|
460
|
+
# Output only. The time at which this {::Google::Cloud::Kms::V1::ImportJob ImportJob} was created.
|
461
461
|
# @!attribute [r] generate_time
|
462
|
-
# @return [Google::Protobuf::Timestamp]
|
463
|
-
# Output only. The time this {Google::Cloud::Kms::V1::ImportJob ImportJob}'s key material was generated.
|
462
|
+
# @return [::Google::Protobuf::Timestamp]
|
463
|
+
# Output only. The time this {::Google::Cloud::Kms::V1::ImportJob ImportJob}'s key material was generated.
|
464
464
|
# @!attribute [r] expire_time
|
465
|
-
# @return [Google::Protobuf::Timestamp]
|
466
|
-
# Output only. The time at which this {Google::Cloud::Kms::V1::ImportJob ImportJob} is scheduled for
|
465
|
+
# @return [::Google::Protobuf::Timestamp]
|
466
|
+
# Output only. The time at which this {::Google::Cloud::Kms::V1::ImportJob ImportJob} is scheduled for
|
467
467
|
# expiration and can no longer be used to import key material.
|
468
468
|
# @!attribute [r] expire_event_time
|
469
|
-
# @return [Google::Protobuf::Timestamp]
|
470
|
-
# Output only. The time this {Google::Cloud::Kms::V1::ImportJob ImportJob} expired. Only present if
|
471
|
-
# {Google::Cloud::Kms::V1::ImportJob#state state} is {Google::Cloud::Kms::V1::ImportJob::ImportJobState::EXPIRED EXPIRED}.
|
469
|
+
# @return [::Google::Protobuf::Timestamp]
|
470
|
+
# Output only. The time this {::Google::Cloud::Kms::V1::ImportJob ImportJob} expired. Only present if
|
471
|
+
# {::Google::Cloud::Kms::V1::ImportJob#state state} is {::Google::Cloud::Kms::V1::ImportJob::ImportJobState::EXPIRED EXPIRED}.
|
472
472
|
# @!attribute [r] state
|
473
|
-
# @return [Google::Cloud::Kms::V1::ImportJob::ImportJobState]
|
474
|
-
# Output only. The current state of the {Google::Cloud::Kms::V1::ImportJob ImportJob}, indicating if it can
|
473
|
+
# @return [::Google::Cloud::Kms::V1::ImportJob::ImportJobState]
|
474
|
+
# Output only. The current state of the {::Google::Cloud::Kms::V1::ImportJob ImportJob}, indicating if it can
|
475
475
|
# be used.
|
476
476
|
# @!attribute [r] public_key
|
477
|
-
# @return [Google::Cloud::Kms::V1::ImportJob::WrappingPublicKey]
|
477
|
+
# @return [::Google::Cloud::Kms::V1::ImportJob::WrappingPublicKey]
|
478
478
|
# Output only. The public key with which to wrap key material prior to
|
479
|
-
# import. Only returned if {Google::Cloud::Kms::V1::ImportJob#state state} is
|
480
|
-
# {Google::Cloud::Kms::V1::ImportJob::ImportJobState::ACTIVE ACTIVE}.
|
479
|
+
# import. Only returned if {::Google::Cloud::Kms::V1::ImportJob#state state} is
|
480
|
+
# {::Google::Cloud::Kms::V1::ImportJob::ImportJobState::ACTIVE ACTIVE}.
|
481
481
|
# @!attribute [r] attestation
|
482
|
-
# @return [Google::Cloud::Kms::V1::KeyOperationAttestation]
|
482
|
+
# @return [::Google::Cloud::Kms::V1::KeyOperationAttestation]
|
483
483
|
# Output only. Statement that was generated and signed by the key creator
|
484
484
|
# (for example, an HSM) at key creation time. Use this statement to verify
|
485
485
|
# attributes of the key as stored on the HSM, independently of Google.
|
486
|
-
# Only present if the chosen {Google::Cloud::Kms::V1::ImportJob::ImportMethod ImportMethod} is one with a protection
|
487
|
-
# level of {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM}.
|
486
|
+
# Only present if the chosen {::Google::Cloud::Kms::V1::ImportJob::ImportMethod ImportMethod} is one with a protection
|
487
|
+
# level of {::Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM}.
|
488
488
|
class ImportJob
|
489
|
-
include Google::Protobuf::MessageExts
|
490
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
489
|
+
include ::Google::Protobuf::MessageExts
|
490
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
491
491
|
|
492
492
|
# The public key component of the wrapping key. For details of the type of
|
493
|
-
# key this public key corresponds to, see the {Google::Cloud::Kms::V1::ImportJob::ImportMethod ImportMethod}.
|
493
|
+
# key this public key corresponds to, see the {::Google::Cloud::Kms::V1::ImportJob::ImportMethod ImportMethod}.
|
494
494
|
# @!attribute [rw] pem
|
495
|
-
# @return [String]
|
495
|
+
# @return [::String]
|
496
496
|
# The public key, encoded in PEM format. For more information, see the [RFC
|
497
497
|
# 7468](https://tools.ietf.org/html/rfc7468) sections for [General
|
498
498
|
# Considerations](https://tools.ietf.org/html/rfc7468#section-2) and
|
499
499
|
# [Textual Encoding of Subject Public Key Info]
|
500
500
|
# (https://tools.ietf.org/html/rfc7468#section-13).
|
501
501
|
class WrappingPublicKey
|
502
|
-
include Google::Protobuf::MessageExts
|
503
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
502
|
+
include ::Google::Protobuf::MessageExts
|
503
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
504
504
|
end
|
505
505
|
|
506
|
-
# {Google::Cloud::Kms::V1::ImportJob::ImportMethod ImportMethod} describes the key wrapping method chosen for this
|
507
|
-
# {Google::Cloud::Kms::V1::ImportJob ImportJob}.
|
506
|
+
# {::Google::Cloud::Kms::V1::ImportJob::ImportMethod ImportMethod} describes the key wrapping method chosen for this
|
507
|
+
# {::Google::Cloud::Kms::V1::ImportJob ImportJob}.
|
508
508
|
module ImportMethod
|
509
509
|
# Not specified.
|
510
510
|
IMPORT_METHOD_UNSPECIFIED = 0
|
@@ -526,19 +526,19 @@ module Google
|
|
526
526
|
RSA_OAEP_4096_SHA1_AES_256 = 2
|
527
527
|
end
|
528
528
|
|
529
|
-
# The state of the {Google::Cloud::Kms::V1::ImportJob ImportJob}, indicating if it can be used.
|
529
|
+
# The state of the {::Google::Cloud::Kms::V1::ImportJob ImportJob}, indicating if it can be used.
|
530
530
|
module ImportJobState
|
531
531
|
# Not specified.
|
532
532
|
IMPORT_JOB_STATE_UNSPECIFIED = 0
|
533
533
|
|
534
534
|
# The wrapping key for this job is still being generated. It may not be
|
535
535
|
# used. Cloud KMS will automatically mark this job as
|
536
|
-
# {Google::Cloud::Kms::V1::ImportJob::ImportJobState::ACTIVE ACTIVE} as soon as the wrapping key is generated.
|
536
|
+
# {::Google::Cloud::Kms::V1::ImportJob::ImportJobState::ACTIVE ACTIVE} as soon as the wrapping key is generated.
|
537
537
|
PENDING_GENERATION = 1
|
538
538
|
|
539
539
|
# This job may be used in
|
540
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key CreateCryptoKey} and
|
541
|
-
# {Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key_version CreateCryptoKeyVersion}
|
540
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key CreateCryptoKey} and
|
541
|
+
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#create_crypto_key_version CreateCryptoKeyVersion}
|
542
542
|
# requests.
|
543
543
|
ACTIVE = 2
|
544
544
|
|
@@ -548,17 +548,17 @@ module Google
|
|
548
548
|
end
|
549
549
|
|
550
550
|
# ExternalProtectionLevelOptions stores a group of additional fields for
|
551
|
-
# configuring a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} that are specific to the
|
552
|
-
# {Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL EXTERNAL} protection level.
|
551
|
+
# configuring a {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} that are specific to the
|
552
|
+
# {::Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL EXTERNAL} protection level.
|
553
553
|
# @!attribute [rw] external_key_uri
|
554
|
-
# @return [String]
|
555
|
-
# The URI for an external resource that this {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} represents.
|
554
|
+
# @return [::String]
|
555
|
+
# The URI for an external resource that this {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} represents.
|
556
556
|
class ExternalProtectionLevelOptions
|
557
|
-
include Google::Protobuf::MessageExts
|
558
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
557
|
+
include ::Google::Protobuf::MessageExts
|
558
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
559
559
|
end
|
560
560
|
|
561
|
-
# {Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevel} specifies how cryptographic operations are performed.
|
561
|
+
# {::Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevel} specifies how cryptographic operations are performed.
|
562
562
|
# For more information, see [Protection levels]
|
563
563
|
# (https://cloud.google.com/kms/docs/algorithms#protection_levels).
|
564
564
|
module ProtectionLevel
|