google-cloud-design_center-v1 0.a → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +151 -8
  5. data/lib/google/cloud/design_center/v1/bindings_override.rb +108 -0
  6. data/lib/google/cloud/design_center/v1/design_center/client.rb +8904 -0
  7. data/lib/google/cloud/design_center/v1/design_center/credentials.rb +47 -0
  8. data/lib/google/cloud/design_center/v1/design_center/operations.rb +843 -0
  9. data/lib/google/cloud/design_center/v1/design_center/paths.rb +477 -0
  10. data/lib/google/cloud/design_center/v1/design_center/rest/client.rb +8308 -0
  11. data/lib/google/cloud/design_center/v1/design_center/rest/operations.rb +927 -0
  12. data/lib/google/cloud/design_center/v1/design_center/rest/service_stub.rb +5000 -0
  13. data/lib/google/cloud/design_center/v1/design_center/rest.rb +54 -0
  14. data/lib/google/cloud/design_center/v1/design_center.rb +56 -0
  15. data/lib/google/cloud/design_center/v1/rest.rb +38 -0
  16. data/lib/google/cloud/design_center/v1/version.rb +7 -2
  17. data/lib/google/cloud/design_center/v1.rb +45 -0
  18. data/lib/google/cloud/designcenter/v1/apphub_integration_messages_pb.rb +27 -0
  19. data/lib/google/cloud/designcenter/v1/apphub_integration_pb.rb +24 -0
  20. data/lib/google/cloud/designcenter/v1/assessment_pb.rb +48 -0
  21. data/lib/google/cloud/designcenter/v1/authoring_messages_pb.rb +73 -0
  22. data/lib/google/cloud/designcenter/v1/authoring_pb.rb +46 -0
  23. data/lib/google/cloud/designcenter/v1/best_practices_messages_pb.rb +45 -0
  24. data/lib/google/cloud/designcenter/v1/best_practices_pb.rb +29 -0
  25. data/lib/google/cloud/designcenter/v1/catalog_management_messages_pb.rb +54 -0
  26. data/lib/google/cloud/designcenter/v1/catalog_management_pb.rb +34 -0
  27. data/lib/google/cloud/designcenter/v1/deployment_messages_pb.rb +56 -0
  28. data/lib/google/cloud/designcenter/v1/deployment_pb.rb +50 -0
  29. data/lib/google/cloud/designcenter/v1/deployment_resources_pb.rb +35 -0
  30. data/lib/google/cloud/designcenter/v1/designcenter_pb.rb +50 -0
  31. data/lib/google/cloud/designcenter/v1/designcenter_services_pb.rb +229 -0
  32. data/lib/google/cloud/designcenter/v1/enums_pb.rb +31 -0
  33. data/lib/google/cloud/designcenter/v1/export_pb.rb +29 -0
  34. data/lib/google/cloud/designcenter/v1/iac_pb.rb +30 -0
  35. data/lib/google/cloud/designcenter/v1/ingestion_pb.rb +35 -0
  36. data/lib/google/cloud/designcenter/v1/metadata_pb.rb +74 -0
  37. data/lib/google/cloud/designcenter/v1/parameters_pb.rb +30 -0
  38. data/lib/google/cloud/designcenter/v1/sharing_messages_pb.rb +42 -0
  39. data/lib/google/cloud/designcenter/v1/sharing_pb.rb +33 -0
  40. data/lib/google-cloud-design_center-v1.rb +21 -0
  41. data/proto_docs/README.md +4 -0
  42. data/proto_docs/google/api/client.rb +593 -0
  43. data/proto_docs/google/api/field_behavior.rb +85 -0
  44. data/proto_docs/google/api/field_info.rb +88 -0
  45. data/proto_docs/google/api/launch_stage.rb +71 -0
  46. data/proto_docs/google/api/resource.rb +227 -0
  47. data/proto_docs/google/cloud/apphub/v1/application.rb +149 -0
  48. data/proto_docs/google/cloud/apphub/v1/attributes.rb +115 -0
  49. data/proto_docs/google/cloud/apphub/v1/properties.rb +94 -0
  50. data/proto_docs/google/cloud/config/v1/config.rb +2709 -0
  51. data/proto_docs/google/cloud/designcenter/v1/apphub_integration.rb +55 -0
  52. data/proto_docs/google/cloud/designcenter/v1/apphub_integration_messages.rb +81 -0
  53. data/proto_docs/google/cloud/designcenter/v1/assessment.rb +502 -0
  54. data/proto_docs/google/cloud/designcenter/v1/authoring.rb +492 -0
  55. data/proto_docs/google/cloud/designcenter/v1/authoring_messages.rb +779 -0
  56. data/proto_docs/google/cloud/designcenter/v1/best_practices.rb +123 -0
  57. data/proto_docs/google/cloud/designcenter/v1/best_practices_messages.rb +296 -0
  58. data/proto_docs/google/cloud/designcenter/v1/catalog_management.rb +258 -0
  59. data/proto_docs/google/cloud/designcenter/v1/catalog_management_messages.rb +438 -0
  60. data/proto_docs/google/cloud/designcenter/v1/deployment.rb +476 -0
  61. data/proto_docs/google/cloud/designcenter/v1/deployment_messages.rb +466 -0
  62. data/proto_docs/google/cloud/designcenter/v1/deployment_resources.rb +182 -0
  63. data/proto_docs/google/cloud/designcenter/v1/designcenter.rb +245 -0
  64. data/proto_docs/google/cloud/designcenter/v1/enums.rb +223 -0
  65. data/proto_docs/google/cloud/designcenter/v1/export.rb +112 -0
  66. data/proto_docs/google/cloud/designcenter/v1/iac.rb +138 -0
  67. data/proto_docs/google/cloud/designcenter/v1/ingestion.rb +276 -0
  68. data/proto_docs/google/cloud/designcenter/v1/metadata.rb +945 -0
  69. data/proto_docs/google/cloud/designcenter/v1/parameters.rb +112 -0
  70. data/proto_docs/google/cloud/designcenter/v1/sharing.rb +188 -0
  71. data/proto_docs/google/cloud/designcenter/v1/sharing_messages.rb +258 -0
  72. data/proto_docs/google/longrunning/operations.rb +191 -0
  73. data/proto_docs/google/protobuf/any.rb +145 -0
  74. data/proto_docs/google/protobuf/duration.rb +98 -0
  75. data/proto_docs/google/protobuf/empty.rb +34 -0
  76. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  77. data/proto_docs/google/protobuf/struct.rb +108 -0
  78. data/proto_docs/google/protobuf/timestamp.rb +128 -0
  79. data/proto_docs/google/rpc/status.rb +48 -0
  80. metadata +168 -9
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DesignCenter
23
+ module V1
24
+ # UnregisteredResource represents a GCP resource that failed to register and
25
+ # apphub was not able to discover.
26
+ # @!attribute [r] deployed_resource
27
+ # @return [::Google::Cloud::DesignCenter::V1::DeployedResource]
28
+ # Output only. The deployed GCP resource that failed to register.
29
+ # @!attribute [r] reason
30
+ # @return [::String]
31
+ # Output only. The reason for the failure of registration.
32
+ class UnregisteredResource
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
+ end
36
+
37
+ # DeployedResource represents a single deployed GCP resource.
38
+ # @!attribute [rw] resource_id
39
+ # @return [::String]
40
+ # Required. The full resource name of the deployed GCP resource.
41
+ # Example: projects/my-project/locations/us-central1-a/instances/my-instance
42
+ # @!attribute [rw] project
43
+ # @return [::String]
44
+ # Optional. The project ID of the deployed resource.
45
+ # @!attribute [rw] location
46
+ # @return [::String]
47
+ # Optional. The location of the deployed resource.
48
+ class DeployedResource
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+ end
52
+ end
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,81 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DesignCenter
23
+ module V1
24
+ # Request message for RegisterAppHubApplicationResources method.
25
+ # @!attribute [rw] tfstate_content
26
+ # @return [::String]
27
+ # Optional. The Terraform state (tfstate) content as a raw string.
28
+ # For large state files exceeding 10MB, use the 'tfstate_signed_gcs_uri'
29
+ # field instead.
30
+ #
31
+ # Note: The following fields are mutually exclusive: `tfstate_content`, `tfstate_signed_gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
32
+ # @!attribute [rw] tfstate_signed_gcs_uri
33
+ # @return [::String]
34
+ # Optional. A securely signed Cloud Storage URI pointing to the tfstate
35
+ # file. The URI must be signed to grant the service temporary read access
36
+ # to the state file. Application Design Center imposes a limit on the
37
+ # maximum size of the state file accessed via this URI.
38
+ #
39
+ # Note: The following fields are mutually exclusive: `tfstate_signed_gcs_uri`, `tfstate_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
40
+ # @!attribute [rw] parent
41
+ # @return [::String]
42
+ # Required. The parent location.
43
+ # Format: projects/\\{project}/locations/\\{location}
44
+ # @!attribute [rw] apphub_application
45
+ # @return [::String]
46
+ # Required. The name of the AppHub Application.
47
+ # Format:
48
+ # projects/\\{project}/locations/\\{location}/applications/\\{application}
49
+ class RegisterAppHubApplicationResourcesRequest
50
+ include ::Google::Protobuf::MessageExts
51
+ extend ::Google::Protobuf::MessageExts::ClassMethods
52
+ end
53
+
54
+ # Response message for RegisterAppHubApplicationResources method.
55
+ # @!attribute [rw] response
56
+ # @return [::Google::Cloud::DesignCenter::V1::DeployedResourceResponse]
57
+ # The response for the registration of deployed resources of a given AppHub
58
+ # application.
59
+ class RegisterAppHubApplicationResourcesResponse
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # Common response message for the resource registration methods.
65
+ # @!attribute [rw] apphub_application
66
+ # @return [::String]
67
+ # The App Hub application name.
68
+ # @!attribute [rw] registered_resources
69
+ # @return [::Array<::String>]
70
+ # The list of successfully registered GCP resources.
71
+ # @!attribute [rw] unregistered_resources
72
+ # @return [::Array<::Google::Cloud::DesignCenter::V1::UnregisteredResource>]
73
+ # The list of unregistered GCP resources with error details.
74
+ class DeployedResourceResponse
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end
@@ -0,0 +1,502 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DesignCenter
23
+ module V1
24
+ # The assessment report for each domain.
25
+ # @!attribute [rw] report_name
26
+ # @return [::String]
27
+ # Optional. The report name as per Application Design Center.
28
+ # @!attribute [r] domain_id
29
+ # @return [::String]
30
+ # Output only. The ID of the domain.
31
+ # @!attribute [r] create_time
32
+ # @return [::Google::Protobuf::Timestamp]
33
+ # Output only. The time at which the report was created.
34
+ # @!attribute [r] update_time
35
+ # @return [::Google::Protobuf::Timestamp]
36
+ # Output only. The time at which the report was last updated.
37
+ # @!attribute [rw] status
38
+ # @return [::Google::Cloud::DesignCenter::V1::DomainAssessmentReport::Status]
39
+ # Optional. Status of assessment report.
40
+ # @!attribute [r] adc_metadata
41
+ # @return [::Google::Cloud::DesignCenter::V1::AdcMetadata]
42
+ # Output only. Specific information and metadata.
43
+ # @!attribute [rw] assessed_frameworks
44
+ # @return [::Array<::Google::Cloud::DesignCenter::V1::AssessedFramework>]
45
+ # Required. List of frameworks assessed and their findings.
46
+ # @!attribute [rw] additional_info
47
+ # @return [::String]
48
+ # Optional. Additional information about the report.
49
+ # @!attribute [rw] skipped_asset_types
50
+ # @return [::Array<::String>]
51
+ # Optional. List of asset types skipped during assessment.
52
+ # @!attribute [rw] domain_redirect_info
53
+ # @return [::Google::Cloud::DesignCenter::V1::DomainAssessmentReport::DomainRedirectInfo]
54
+ # Optional. Information on how to redirect to domain.
55
+ # @!attribute [r] report_score
56
+ # @return [::Google::Cloud::DesignCenter::V1::ScoreCard]
57
+ # Output only. Score card associated with the report.
58
+ class DomainAssessmentReport
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
+
62
+ # Information on how to redirect to domain.
63
+ # @!attribute [rw] url
64
+ # @return [::String]
65
+ # Required. URL to the domain page.
66
+ # @!attribute [rw] url_text
67
+ # @return [::String]
68
+ # Required. Text to display in UI on the redirect URL.
69
+ # @!attribute [rw] open_in_same_tab
70
+ # @return [::Boolean]
71
+ # Optional. Flag to open the URL in new tab. Default: false.
72
+ class DomainRedirectInfo
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+ end
76
+
77
+ # Status of domain assessment report.
78
+ module Status
79
+ # No status specified.
80
+ STATUS_UNSPECIFIED = 0
81
+
82
+ # Pending domain assessment.
83
+ PENDING = 1
84
+
85
+ # Complete domain assessment.
86
+ COMPLETED = 2
87
+
88
+ # Failed domain assessment.
89
+ FAILED = 3
90
+ end
91
+ end
92
+
93
+ # Score card associated with the report.
94
+ # @!attribute [rw] report_score
95
+ # @return [::Integer]
96
+ # Required. Calculated score of the report.
97
+ # @!attribute [rw] max_score
98
+ # @return [::Integer]
99
+ # Required. Maximum score of the report.
100
+ # For example, for a score of 75/100, report_score is 75 and max_score is
101
+ # 100.
102
+ # @!attribute [rw] min_score_required
103
+ # @return [::Integer]
104
+ # Optional. Minimum score required to pass assessment.
105
+ # @!attribute [rw] average_score
106
+ # @return [::Integer]
107
+ # Optional. Average score for similar reports.
108
+ class ScoreCard
109
+ include ::Google::Protobuf::MessageExts
110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
111
+ end
112
+
113
+ # Condition for applying the policy. Accepts the `criticality`
114
+ # and `environment` parameters from the application template.
115
+ # @!attribute [rw] condition_key
116
+ # @return [::String]
117
+ # Required. The key of the parameter for the condition.
118
+ # @!attribute [rw] condition_value
119
+ # @return [::String]
120
+ # Required. The value of the parameter for the condition.
121
+ class ApplyCondition
122
+ include ::Google::Protobuf::MessageExts
123
+ extend ::Google::Protobuf::MessageExts::ClassMethods
124
+ end
125
+
126
+ # Domains skipped during the best practice assessment.
127
+ # @!attribute [r] domain
128
+ # @return [::Google::Cloud::DesignCenter::V1::Domain]
129
+ # Output only. Details of the domain skipped.
130
+ # @!attribute [r] skip_reason
131
+ # @return [::Google::Cloud::DesignCenter::V1::SkippedDomain::Reason]
132
+ # Output only. Reason for skipping the domain from assessment.
133
+ class SkippedDomain
134
+ include ::Google::Protobuf::MessageExts
135
+ extend ::Google::Protobuf::MessageExts::ClassMethods
136
+
137
+ # Reason for skipping the domain from assessment.
138
+ module Reason
139
+ # No reason specified.
140
+ REASON_UNSPECIFIED = 0
141
+
142
+ # Domain is unavailable.
143
+ UNAVAILABLE = 1
144
+
145
+ # Domain assessment failed.
146
+ FAILURE = 2
147
+
148
+ # Domain assessment timed out.
149
+ TIMEOUT = 3
150
+ end
151
+ end
152
+
153
+ # Domain for assessment.
154
+ # @!attribute [rw] domain_name
155
+ # @return [::String]
156
+ # Required. The domain name. Uniquely identifies the domain.
157
+ # @!attribute [rw] display_name
158
+ # @return [::String]
159
+ # Optional. The domain display name is user friendly name used for UI.
160
+ # @!attribute [rw] description
161
+ # @return [::String]
162
+ # Optional. The domain description.
163
+ # @!attribute [rw] frameworks
164
+ # @return [::Array<::Google::Cloud::DesignCenter::V1::Framework>]
165
+ # Optional. The frameworks that are applicable in this domain.
166
+ # @!attribute [rw] inactive
167
+ # @return [::Boolean]
168
+ # Optional. Whether the domain is inactive.
169
+ # Default: false.
170
+ class Domain
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Framework for assessment.
176
+ # @!attribute [rw] name
177
+ # @return [::String]
178
+ # Required. The framework name.
179
+ # @!attribute [rw] major_revision_id
180
+ # @return [::Integer]
181
+ # Optional. The major revision id of the framework.
182
+ # @!attribute [rw] parent_domain
183
+ # @return [::Google::Cloud::DesignCenter::V1::Domain]
184
+ # Required. The domain to which this framework belongs.
185
+ # @!attribute [rw] display_name
186
+ # @return [::String]
187
+ # Optional. The framework display name.
188
+ # @!attribute [rw] description
189
+ # @return [::String]
190
+ # Optional. The framework description.
191
+ # @!attribute [rw] url
192
+ # @return [::String]
193
+ # Optional. The URL to a framework.
194
+ # @!attribute [rw] active
195
+ # @return [::Boolean]
196
+ # Optional. Whether the framework is active.
197
+ # @!attribute [rw] cloud_control_details
198
+ # @return [::Array<::Google::Cloud::DesignCenter::V1::CloudControl>]
199
+ # Optional. The cloud controls that are associated with the framework.
200
+ # @!attribute [rw] deployment_status
201
+ # @return [::Google::Cloud::DesignCenter::V1::Framework::DeploymentStatus]
202
+ # Optional. The deployment status of the framework.
203
+ # @!attribute [r] managed_project_applicable
204
+ # @return [::Boolean]
205
+ # Output only. Indicates if the framework is defined in the managed project.
206
+ # Only managed-project frameworks can be manually attached.
207
+ class Framework
208
+ include ::Google::Protobuf::MessageExts
209
+ extend ::Google::Protobuf::MessageExts::ClassMethods
210
+
211
+ # Enum for deployment status of a framework.
212
+ module DeploymentStatus
213
+ # Deployment status unspecified.
214
+ DEPLOYMENT_STATUS_UNSPECIFIED = 0
215
+
216
+ # Framework is deployed.
217
+ DEPLOYED = 1
218
+
219
+ # Framework is undeployed.
220
+ UNDEPLOYED = 2
221
+ end
222
+ end
223
+
224
+ # Cloud control for a framework.
225
+ # @!attribute [rw] name
226
+ # @return [::String]
227
+ # Required. The name of the cloud control.
228
+ # @!attribute [rw] description
229
+ # @return [::String]
230
+ # Optional. The description of the cloud control.
231
+ # @!attribute [rw] major_revision_id
232
+ # @return [::Integer]
233
+ # Required. The major revision id of the cloud control.
234
+ # @!attribute [rw] enforcement_mode
235
+ # @return [::Google::Cloud::DesignCenter::V1::CloudControl::EnforcementMode]
236
+ # Optional. The enforcement mode of the cloud control.
237
+ # @!attribute [rw] parameter_specs
238
+ # @return [::Array<::Google::Cloud::DesignCenter::V1::ParameterSpec>]
239
+ # Optional. The specifications of the parameters supported by the cloud
240
+ # control.
241
+ # @!attribute [rw] parameters
242
+ # @return [::Array<::Google::Cloud::DesignCenter::V1::Parameter>]
243
+ # Optional. The parameter values that are already configured for the cloud
244
+ # control, if any. Used to pre-populate the parameter values presented to the
245
+ # user.
246
+ class CloudControl
247
+ include ::Google::Protobuf::MessageExts
248
+ extend ::Google::Protobuf::MessageExts::ClassMethods
249
+
250
+ # Enum for enforcement mode of a cloud control.
251
+ module EnforcementMode
252
+ # Enforcement type unspecified.
253
+ ENFORCEMENT_MODE_UNSPECIFIED = 0
254
+
255
+ # The cloud control is enforced to prevent non-compliance.
256
+ PREVENTIVE = 1
257
+
258
+ # The cloud control is enforced to detect non-compliance.
259
+ DETECTIVE = 2
260
+
261
+ # The cloud control is enforced to audit for non-compliance.
262
+ AUDIT = 3
263
+ end
264
+ end
265
+
266
+ # The specification of a parameter that can be configured on a cloud control
267
+ # or a framework.
268
+ # @!attribute [rw] key
269
+ # @return [::String]
270
+ # Required. The key of the parameter, matching
271
+ # {::Google::Cloud::DesignCenter::V1::Parameter#key Parameter.key} of the
272
+ # value supplied for it.
273
+ # @!attribute [rw] display_name
274
+ # @return [::String]
275
+ # Optional. The parameter display name, which is a user friendly name used
276
+ # for UI.
277
+ # @!attribute [rw] description
278
+ # @return [::String]
279
+ # Optional. The parameter description.
280
+ # @!attribute [rw] required
281
+ # @return [::Boolean]
282
+ # Optional. Whether a value must be provided for the parameter.
283
+ # @!attribute [rw] value_type
284
+ # @return [::Google::Cloud::DesignCenter::V1::ParameterSpec::ValueType]
285
+ # Optional. The type of value that the parameter accepts.
286
+ # @!attribute [rw] default_value
287
+ # @return [::Google::Protobuf::Value]
288
+ # Optional. The default value of the parameter, used when the user does not
289
+ # provide one.
290
+ # @!attribute [rw] sub_parameter_specs
291
+ # @return [::Array<::Google::Cloud::DesignCenter::V1::ParameterSpec>]
292
+ # Optional. The specifications of the sub-parameters. Only set when
293
+ # `value_type` is `ONEOF`.
294
+ class ParameterSpec
295
+ include ::Google::Protobuf::MessageExts
296
+ extend ::Google::Protobuf::MessageExts::ClassMethods
297
+
298
+ # The type of value that the parameter accepts.
299
+ module ValueType
300
+ # Default. This value is unused.
301
+ VALUE_TYPE_UNSPECIFIED = 0
302
+
303
+ # A string value.
304
+ STRING = 3
305
+
306
+ # A boolean value.
307
+ BOOLEAN = 4
308
+
309
+ # A list of string values.
310
+ STRINGLIST = 5
311
+
312
+ # A numeric value.
313
+ NUMBER = 6
314
+
315
+ # Exactly one of the sub-parameters must be provided.
316
+ ONEOF = 7
317
+ end
318
+ end
319
+
320
+ # Application Design Center specific information and metadata.
321
+ # @!attribute [r] application_uri
322
+ # @return [::String]
323
+ # Output only. Application URI
324
+ #
325
+ # Note: The following fields are mutually exclusive: `application_uri`, `application_template_uri`, `space_uri`, `catalog_template_revision_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
326
+ # @!attribute [r] application_template_uri
327
+ # @return [::String]
328
+ # Output only. ApplicationTemplate URI
329
+ #
330
+ # Note: The following fields are mutually exclusive: `application_template_uri`, `application_uri`, `space_uri`, `catalog_template_revision_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
331
+ # @!attribute [r] space_uri
332
+ # @return [::String]
333
+ # Output only. Space URI
334
+ #
335
+ # Note: The following fields are mutually exclusive: `space_uri`, `application_uri`, `application_template_uri`, `catalog_template_revision_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
336
+ # @!attribute [r] catalog_template_revision_uri
337
+ # @return [::String]
338
+ # Output only. CatalogTemplateRevision URI
339
+ #
340
+ # Note: The following fields are mutually exclusive: `catalog_template_revision_uri`, `application_uri`, `application_template_uri`, `space_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
341
+ class AdcMetadata
342
+ include ::Google::Protobuf::MessageExts
343
+ extend ::Google::Protobuf::MessageExts::ClassMethods
344
+ end
345
+
346
+ # Framework assessed and their findings.
347
+ # @!attribute [rw] framework
348
+ # @return [::Google::Cloud::DesignCenter::V1::Framework]
349
+ # Required. The framework that was assessed.
350
+ # @!attribute [rw] findings
351
+ # @return [::Array<::Google::Cloud::DesignCenter::V1::AssessmentFinding>]
352
+ # Required. A list of every Finding found during the assessment.
353
+ # @!attribute [rw] score_card
354
+ # @return [::Google::Cloud::DesignCenter::V1::ScoreCard]
355
+ # Optional. Score card associated with the report.
356
+ # @!attribute [rw] skipped
357
+ # @return [::Boolean]
358
+ # Optional. Whether the framework was skipped during assessment.
359
+ # @!attribute [rw] skipped_reason
360
+ # @return [::String]
361
+ # Optional. Reason for skipping the framework during assessment.
362
+ class AssessedFramework
363
+ include ::Google::Protobuf::MessageExts
364
+ extend ::Google::Protobuf::MessageExts::ClassMethods
365
+ end
366
+
367
+ # Details of an Assessment Finding.
368
+ # @!attribute [rw] remediation_step
369
+ # @return [::Google::Cloud::DesignCenter::V1::RemediationStep]
370
+ # Optional. A description of the steps that users can take to fix the
371
+ # finding.
372
+ # @!attribute [rw] additional_notes
373
+ # @return [::String]
374
+ # Optional. A description of the additional details about finding.
375
+ # @!attribute [r] id
376
+ # @return [::String]
377
+ # Output only. The Finding ID.
378
+ # @!attribute [rw] assessed_framework_id
379
+ # @return [::String]
380
+ # Optional. The framework that was assessed.
381
+ # @!attribute [r] adc_metadata
382
+ # @return [::Google::Cloud::DesignCenter::V1::AssessmentFinding::FindingADCMetadata]
383
+ # Output only. Metadata related to the Application Design Center with the
384
+ # finding.
385
+ # @!attribute [rw] finding_type
386
+ # @return [::Google::Cloud::DesignCenter::V1::AssessmentFinding::Type]
387
+ # Required. The type of the finding. Findings can be informational,
388
+ # warning, or error.
389
+ # @!attribute [rw] severity
390
+ # @return [::Google::Cloud::DesignCenter::V1::AssessmentFinding::Severity]
391
+ # Optional. The severity of the finding.
392
+ # @!attribute [rw] assessed_asset
393
+ # @return [::Google::Cloud::DesignCenter::V1::AssetDetails]
394
+ # Required. Details of the Cloud Asset Inventory asset that was assessed.
395
+ # @!attribute [rw] assessed_framework
396
+ # @return [::Google::Cloud::DesignCenter::V1::Framework]
397
+ # Optional. Details of the framework that was assessed.
398
+ # @!attribute [rw] description
399
+ # @return [::String]
400
+ # Optional. Description of the finding.
401
+ # @!attribute [rw] findings_uri
402
+ # @return [::String]
403
+ # Optional. Link to the findings, if persisted by the domain.
404
+ # @!attribute [r] scc_metadata
405
+ # @return [::Google::Cloud::DesignCenter::V1::SCCMetadata]
406
+ # Output only. SCC related metadata for the finding.
407
+ class AssessmentFinding
408
+ include ::Google::Protobuf::MessageExts
409
+ extend ::Google::Protobuf::MessageExts::ClassMethods
410
+
411
+ # Metadata related to the Application Design Center with the finding.
412
+ # @!attribute [r] component_name
413
+ # @return [::String]
414
+ # Output only. Component the finding belongs to.
415
+ class FindingADCMetadata
416
+ include ::Google::Protobuf::MessageExts
417
+ extend ::Google::Protobuf::MessageExts::ClassMethods
418
+ end
419
+
420
+ # The type of finding.
421
+ module Type
422
+ # Default value. This value is unused.
423
+ TYPE_UNSPECIFIED = 0
424
+
425
+ # Warning finding. Deployment will not be blocked.
426
+ WARNING = 1
427
+
428
+ # Error finding. Deployment will be blocked on ERROR.
429
+ ERROR = 2
430
+ end
431
+
432
+ # The severity of a finding.
433
+ module Severity
434
+ # Default value. This value is unused.
435
+ SEVERITY_UNSPECIFIED = 0
436
+
437
+ # Critical severity.
438
+ CRITICAL = 1
439
+
440
+ # High severity.
441
+ HIGH = 2
442
+
443
+ # Medium severity.
444
+ MEDIUM = 3
445
+
446
+ # Low severity.
447
+ LOW = 4
448
+ end
449
+ end
450
+
451
+ # SCC metadata for the assessment finding.
452
+ # @!attribute [rw] finding_class
453
+ # @return [::String]
454
+ # Optional. The SCC finding class. Also known as category.
455
+ # @!attribute [rw] finding_type
456
+ # @return [::String]
457
+ # Optional. The SCC finding type.
458
+ class SCCMetadata
459
+ include ::Google::Protobuf::MessageExts
460
+ extend ::Google::Protobuf::MessageExts::ClassMethods
461
+ end
462
+
463
+ # Details of a Cloud Asset Inventory asset that caused the finding.
464
+ # @!attribute [rw] asset_id
465
+ # @return [::String]
466
+ # Required. Information about the Cloud Asset Inventory asset that the
467
+ # framework is assessed against. The full resource name of the asset in CAIS
468
+ # format.
469
+ #
470
+ # For details about the format of the full resource name for each asset type,
471
+ # see [Resource name
472
+ # format]
473
+ # (https://cloud.google.com/asset-inventory/docs/resource-name-format).
474
+ # @!attribute [rw] asset_type
475
+ # @return [::String]
476
+ # Optional. The type of Cloud Asset Inventory asset. For a list of asset
477
+ # types, see [Supported asset
478
+ # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
479
+ class AssetDetails
480
+ include ::Google::Protobuf::MessageExts
481
+ extend ::Google::Protobuf::MessageExts::ClassMethods
482
+ end
483
+
484
+ # Remediation steps that can be taken to rectify the finding.
485
+ # @!attribute [rw] remediation_steps
486
+ # @return [::Array<::String>]
487
+ # Required. A description of the steps that users can take to remediate the
488
+ # findings.
489
+ # @!attribute [rw] remediation_documentation_url
490
+ # @return [::String]
491
+ # Optional. Remediation documentation URL.
492
+ # @!attribute [rw] note
493
+ # @return [::String]
494
+ # Optional. Any other note related to the remediation.
495
+ class RemediationStep
496
+ include ::Google::Protobuf::MessageExts
497
+ extend ::Google::Protobuf::MessageExts::ClassMethods
498
+ end
499
+ end
500
+ end
501
+ end
502
+ end