google-cloud-audit_manager-v1 0.a → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +154 -8
- data/lib/google/cloud/audit_manager/v1/audit_manager/client.rb +1275 -0
- data/lib/google/cloud/audit_manager/v1/audit_manager/credentials.rb +47 -0
- data/lib/google/cloud/audit_manager/v1/audit_manager/operations.rb +843 -0
- data/lib/google/cloud/audit_manager/v1/audit_manager/paths.rb +265 -0
- data/lib/google/cloud/audit_manager/v1/audit_manager/rest/client.rb +1184 -0
- data/lib/google/cloud/audit_manager/v1/audit_manager/rest/operations.rb +956 -0
- data/lib/google/cloud/audit_manager/v1/audit_manager/rest/service_stub.rb +660 -0
- data/lib/google/cloud/audit_manager/v1/audit_manager/rest.rb +54 -0
- data/lib/google/cloud/audit_manager/v1/audit_manager.rb +56 -0
- data/lib/google/cloud/audit_manager/v1/bindings_override.rb +75 -0
- data/lib/google/cloud/audit_manager/v1/rest.rb +38 -0
- data/lib/google/cloud/audit_manager/v1/version.rb +7 -2
- data/lib/google/cloud/audit_manager/v1.rb +45 -0
- data/lib/google/cloud/auditmanager/v1/auditmanager_pb.rb +57 -0
- data/lib/google/cloud/auditmanager/v1/auditmanager_services_pb.rb +66 -0
- data/lib/google-cloud-audit_manager-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +593 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/auditmanager/v1/auditmanager.rb +648 -0
- data/proto_docs/google/longrunning/operations.rb +191 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- metadata +79 -9
|
@@ -0,0 +1,648 @@
|
|
|
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 AuditManager
|
|
23
|
+
module V1
|
|
24
|
+
# Request message to subscribe the Audit Manager service for given resource.
|
|
25
|
+
# @!attribute [rw] scope
|
|
26
|
+
# @return [::String]
|
|
27
|
+
# Required. The resource to be enrolled to the audit manager. Scope format
|
|
28
|
+
# should be resource_type/resource_identifier Eg:
|
|
29
|
+
# projects/\\{project}/locations/\\{location},
|
|
30
|
+
# folders/\\{folder}/locations/\\{location}
|
|
31
|
+
# organizations/\\{organization}/locations/\\{location}
|
|
32
|
+
# @!attribute [rw] destinations
|
|
33
|
+
# @return [::Array<::Google::Cloud::AuditManager::V1::EnrollResourceRequest::EligibleDestination>]
|
|
34
|
+
# Required. List of destination among which customer can choose to upload
|
|
35
|
+
# their reports during the audit process. While enrolling at a
|
|
36
|
+
# organization/folder level, customer can choose Cloud storage bucket in any
|
|
37
|
+
# project. If the audit is triggered at project level using the service agent
|
|
38
|
+
# at organization/folder level, all the destination options associated with
|
|
39
|
+
# respective organization/folder level service agent will be available to
|
|
40
|
+
# auditing projects.
|
|
41
|
+
class EnrollResourceRequest
|
|
42
|
+
include ::Google::Protobuf::MessageExts
|
|
43
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
44
|
+
|
|
45
|
+
# The destination details where the audit report must be uploaded.
|
|
46
|
+
# @!attribute [rw] eligible_gcs_bucket
|
|
47
|
+
# @return [::String]
|
|
48
|
+
# The Cloud Storage bucket location where the audit report and evidences
|
|
49
|
+
# can be uploaded during the `GenerateAuditReport` API call.
|
|
50
|
+
class EligibleDestination
|
|
51
|
+
include ::Google::Protobuf::MessageExts
|
|
52
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# Message for requesting audit scope report.
|
|
57
|
+
# @!attribute [rw] scope
|
|
58
|
+
# @return [::String]
|
|
59
|
+
# Required. Scope for which the AuditScopeReport is required. Must be of
|
|
60
|
+
# format resource_type/resource_identifier Eg:
|
|
61
|
+
# projects/\\{project}/locations/\\{location},
|
|
62
|
+
# folders/\\{folder}/locations/\\{location}
|
|
63
|
+
# @!attribute [rw] compliance_standard
|
|
64
|
+
# @return [::String]
|
|
65
|
+
# Required. Compliance Standard against which the Scope Report must be
|
|
66
|
+
# generated. Eg: FEDRAMP_MODERATE
|
|
67
|
+
# @!attribute [rw] report_format
|
|
68
|
+
# @return [::Google::Cloud::AuditManager::V1::GenerateAuditScopeReportRequest::AuditScopeReportFormat]
|
|
69
|
+
# Required. The format in which the Scope report bytes should be returned.
|
|
70
|
+
# @!attribute [rw] compliance_framework
|
|
71
|
+
# @return [::String]
|
|
72
|
+
# Required. Compliance framework against which the Scope Report must be
|
|
73
|
+
# generated.
|
|
74
|
+
class GenerateAuditScopeReportRequest
|
|
75
|
+
include ::Google::Protobuf::MessageExts
|
|
76
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
77
|
+
|
|
78
|
+
# The options for the audit scope report format.
|
|
79
|
+
module AuditScopeReportFormat
|
|
80
|
+
# Unspecified. Invalid format.
|
|
81
|
+
AUDIT_SCOPE_REPORT_FORMAT_UNSPECIFIED = 0
|
|
82
|
+
|
|
83
|
+
# Audit Scope Report creation format is Open Document.
|
|
84
|
+
AUDIT_SCOPE_REPORT_FORMAT_ODF = 1
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Message for requesting the Audit Report.
|
|
89
|
+
# @!attribute [rw] gcs_uri
|
|
90
|
+
# @return [::String]
|
|
91
|
+
# Destination Cloud storage bucket where report and evidence must be
|
|
92
|
+
# uploaded. The Cloud storage bucket provided here must be selected among
|
|
93
|
+
# the buckets entered during the enrollment process.
|
|
94
|
+
# @!attribute [rw] scope
|
|
95
|
+
# @return [::String]
|
|
96
|
+
# Required. Scope for which the AuditScopeReport is required. Must be of
|
|
97
|
+
# format resource_type/resource_identifier Eg:
|
|
98
|
+
# projects/\\{project}/locations/\\{location},
|
|
99
|
+
# folders/\\{folder}/locations/\\{location}
|
|
100
|
+
# @!attribute [rw] compliance_standard
|
|
101
|
+
# @return [::String]
|
|
102
|
+
# Required. Compliance Standard against which the Scope Report must be
|
|
103
|
+
# generated. Eg: FEDRAMP_MODERATE
|
|
104
|
+
# @!attribute [rw] report_format
|
|
105
|
+
# @return [::Google::Cloud::AuditManager::V1::GenerateAuditReportRequest::AuditReportFormat]
|
|
106
|
+
# Required. The format in which the audit report should be created.
|
|
107
|
+
# @!attribute [rw] compliance_framework
|
|
108
|
+
# @return [::String]
|
|
109
|
+
# Required. Compliance framework against which the Report must be generated.
|
|
110
|
+
class GenerateAuditReportRequest
|
|
111
|
+
include ::Google::Protobuf::MessageExts
|
|
112
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
113
|
+
|
|
114
|
+
# The options for the audit report format.
|
|
115
|
+
module AuditReportFormat
|
|
116
|
+
# Unspecified. Invalid state.
|
|
117
|
+
AUDIT_REPORT_FORMAT_UNSPECIFIED = 0
|
|
118
|
+
|
|
119
|
+
# Audit Report creation format is Open Document.
|
|
120
|
+
AUDIT_REPORT_FORMAT_ODF = 1
|
|
121
|
+
end
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# Message for getting the enrollment status of a resource.
|
|
125
|
+
# @!attribute [rw] name
|
|
126
|
+
# @return [::String]
|
|
127
|
+
# Required. Format
|
|
128
|
+
# folders/\\{folder}/locations/\\{location}/resourceEnrollmentStatuses/\\{resource_enrollment_status},
|
|
129
|
+
# projects/\\{project}/locations/\\{location}/resourceEnrollmentStatuses/\\{resource_enrollment_status},
|
|
130
|
+
# organizations/\\{organization}/locations/\\{location}/resourceEnrollmentStatuses/\\{resource_enrollment_status}
|
|
131
|
+
class GetResourceEnrollmentStatusRequest
|
|
132
|
+
include ::Google::Protobuf::MessageExts
|
|
133
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# Message for listing all the descendent resources under parent with
|
|
137
|
+
# enrollment.
|
|
138
|
+
# @!attribute [rw] parent
|
|
139
|
+
# @return [::String]
|
|
140
|
+
# Required. The parent scope for which the list of resources with enrollments
|
|
141
|
+
# are required.
|
|
142
|
+
# @!attribute [rw] page_size
|
|
143
|
+
# @return [::Integer]
|
|
144
|
+
# Optional. The maximum number of resources to return.
|
|
145
|
+
# @!attribute [rw] page_token
|
|
146
|
+
# @return [::String]
|
|
147
|
+
# Optional. The next_page_token value returned from a previous List request,
|
|
148
|
+
# if any.
|
|
149
|
+
class ListResourceEnrollmentStatusesRequest
|
|
150
|
+
include ::Google::Protobuf::MessageExts
|
|
151
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# Response message with all the descendent resources with enrollment.
|
|
155
|
+
# @!attribute [rw] resource_enrollment_statuses
|
|
156
|
+
# @return [::Array<::Google::Cloud::AuditManager::V1::ResourceEnrollmentStatus>]
|
|
157
|
+
# The resources with their enrollment status.
|
|
158
|
+
# @!attribute [r] next_page_token
|
|
159
|
+
# @return [::String]
|
|
160
|
+
# Output only. The token to retrieve the next page of results.
|
|
161
|
+
class ListResourceEnrollmentStatusesResponse
|
|
162
|
+
include ::Google::Protobuf::MessageExts
|
|
163
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
# Message for requesting to list the audit reports.
|
|
167
|
+
# @!attribute [rw] parent
|
|
168
|
+
# @return [::String]
|
|
169
|
+
# Required. The parent scope for which to list the reports.
|
|
170
|
+
# @!attribute [rw] page_size
|
|
171
|
+
# @return [::Integer]
|
|
172
|
+
# Optional. The maximum number of resources to return.
|
|
173
|
+
# @!attribute [rw] page_token
|
|
174
|
+
# @return [::String]
|
|
175
|
+
# Optional. The next_page_token value returned from a previous List request,
|
|
176
|
+
# if any.
|
|
177
|
+
class ListAuditReportsRequest
|
|
178
|
+
include ::Google::Protobuf::MessageExts
|
|
179
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
# Response message with all the audit reports.
|
|
183
|
+
# @!attribute [r] audit_reports
|
|
184
|
+
# @return [::Array<::Google::Cloud::AuditManager::V1::AuditReport>]
|
|
185
|
+
# Output only. The audit reports.
|
|
186
|
+
# @!attribute [r] next_page_token
|
|
187
|
+
# @return [::String]
|
|
188
|
+
# Output only. The token to retrieve the next page of results.
|
|
189
|
+
class ListAuditReportsResponse
|
|
190
|
+
include ::Google::Protobuf::MessageExts
|
|
191
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
192
|
+
end
|
|
193
|
+
|
|
194
|
+
# Message for requesting the overall audit report for an audit report name.
|
|
195
|
+
# @!attribute [rw] name
|
|
196
|
+
# @return [::String]
|
|
197
|
+
# Required. Format
|
|
198
|
+
# projects/\\{project}/locations/\\{location}/auditReports/\\{audit_report},
|
|
199
|
+
# folders/\\{folder}/locations/\\{location}/auditReports/\\{audit_report}
|
|
200
|
+
class GetAuditReportRequest
|
|
201
|
+
include ::Google::Protobuf::MessageExts
|
|
202
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
# Message for requesting all the controls for a compliance standard.
|
|
206
|
+
# @!attribute [rw] parent
|
|
207
|
+
# @return [::String]
|
|
208
|
+
# Required. Format
|
|
209
|
+
# projects/\\{project}/locations/\\{location}/standards/\\{standard},
|
|
210
|
+
# folders/\\{folder}/locations/\\{location}/standards/\\{standard}
|
|
211
|
+
# @!attribute [rw] page_size
|
|
212
|
+
# @return [::Integer]
|
|
213
|
+
# Optional. The maximum number of resources to return.
|
|
214
|
+
# @!attribute [rw] page_token
|
|
215
|
+
# @return [::String]
|
|
216
|
+
# Optional. The next_page_token value returned from a previous List request,
|
|
217
|
+
# if any.
|
|
218
|
+
class ListControlsRequest
|
|
219
|
+
include ::Google::Protobuf::MessageExts
|
|
220
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
# Response message with all the controls for a compliance standard.
|
|
224
|
+
# @!attribute [r] controls
|
|
225
|
+
# @return [::Array<::Google::Cloud::AuditManager::V1::Control>]
|
|
226
|
+
# Output only. The controls for the compliance standard.
|
|
227
|
+
# @!attribute [r] next_page_token
|
|
228
|
+
# @return [::String]
|
|
229
|
+
# Output only. The token to retrieve the next page of results.
|
|
230
|
+
class ListControlsResponse
|
|
231
|
+
include ::Google::Protobuf::MessageExts
|
|
232
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
# The `ReportGenerationProgress` is part of
|
|
236
|
+
# {::Google::Longrunning::Operation google.longrunning.Operation} returned to the
|
|
237
|
+
# client for every `GetOperation` request.
|
|
238
|
+
# @!attribute [r] state
|
|
239
|
+
# @return [::Google::Cloud::AuditManager::V1::OperationState]
|
|
240
|
+
# Output only. The current state of execution for report generation.
|
|
241
|
+
# @!attribute [r] failure_reason
|
|
242
|
+
# @return [::String]
|
|
243
|
+
# Output only. States the reason of failure during the audit report
|
|
244
|
+
# generation process. This field is set only if the state attribute is
|
|
245
|
+
# OPERATION_STATE_FAILED.
|
|
246
|
+
# @!attribute [rw] evaluation_percent_complete
|
|
247
|
+
# @return [::Float]
|
|
248
|
+
# Shows the progress of the CESS service evaluation process. The progress is
|
|
249
|
+
# defined in terms of percentage complete and is being fetched from the CESS
|
|
250
|
+
# service.
|
|
251
|
+
# @!attribute [rw] report_generation_percent_complete
|
|
252
|
+
# @return [::Float]
|
|
253
|
+
# Shows the report generation progress of the CESS Result Processor Service.
|
|
254
|
+
# The // progress is defined in terms of percentage complete and is being
|
|
255
|
+
# fetched from the CESS service. If report_generation_in_progress is non zero
|
|
256
|
+
# then evaluation_percent_complete will be 100%.
|
|
257
|
+
# @!attribute [rw] report_uploading_percent_complete
|
|
258
|
+
# @return [::Float]
|
|
259
|
+
# Shows the report uploading progress of the CESS Result Processor Service.
|
|
260
|
+
# The progress is defined in terms of percentage complete and is being
|
|
261
|
+
# fetched from the CESS service. If report_uploading_in_progress is non zero
|
|
262
|
+
# then evaluation_percent_complete and report_generation_percent_complete
|
|
263
|
+
# will be 100%.
|
|
264
|
+
# @!attribute [r] destination_gcs_bucket
|
|
265
|
+
# @return [::String]
|
|
266
|
+
# Output only. The Cloud Storage bucket where the audit report will be
|
|
267
|
+
# uploaded once the evaluation process is completed.
|
|
268
|
+
# @!attribute [r] audit_report
|
|
269
|
+
# @return [::String]
|
|
270
|
+
# Output only. The name of the audit report.
|
|
271
|
+
class ReportGenerationProgress
|
|
272
|
+
include ::Google::Protobuf::MessageExts
|
|
273
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
274
|
+
end
|
|
275
|
+
|
|
276
|
+
# The enrollment resource.
|
|
277
|
+
# @!attribute [rw] name
|
|
278
|
+
# @return [::String]
|
|
279
|
+
# Identifier. The name of this Enrollment, in the format of scope given in
|
|
280
|
+
# request.
|
|
281
|
+
# @!attribute [r] destination_details
|
|
282
|
+
# @return [::Array<::Google::Cloud::AuditManager::V1::DestinationDetails>]
|
|
283
|
+
# Output only. The locations where the generated reports can be uploaded.
|
|
284
|
+
class Enrollment
|
|
285
|
+
include ::Google::Protobuf::MessageExts
|
|
286
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# The audit scope report.
|
|
290
|
+
# @!attribute [rw] scope_report_contents
|
|
291
|
+
# @return [::String]
|
|
292
|
+
# The audit scope report content in byte format.
|
|
293
|
+
# @!attribute [rw] name
|
|
294
|
+
# @return [::String]
|
|
295
|
+
# Identifier. The name of this Audit Report, in the format of scope given in
|
|
296
|
+
# request.
|
|
297
|
+
class AuditScopeReport
|
|
298
|
+
include ::Google::Protobuf::MessageExts
|
|
299
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
300
|
+
end
|
|
301
|
+
|
|
302
|
+
# The metadata of the long-running operation.
|
|
303
|
+
# @!attribute [r] create_time
|
|
304
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
305
|
+
# Output only. The time the operation was created.
|
|
306
|
+
# @!attribute [r] end_time
|
|
307
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
308
|
+
# Output only. The time the operation finished running.
|
|
309
|
+
# @!attribute [r] target
|
|
310
|
+
# @return [::String]
|
|
311
|
+
# Output only. Server-defined resource path for the target of the operation.
|
|
312
|
+
# @!attribute [r] verb
|
|
313
|
+
# @return [::String]
|
|
314
|
+
# Output only. Name of the verb executed by the operation.
|
|
315
|
+
# @!attribute [r] status_message
|
|
316
|
+
# @return [::String]
|
|
317
|
+
# Output only. Human-readable status of the operation, if any.
|
|
318
|
+
# @!attribute [r] requested_cancellation
|
|
319
|
+
# @return [::Boolean]
|
|
320
|
+
# Output only. Identifies whether the user has requested cancellation
|
|
321
|
+
# of the operation. Operations that have been cancelled successfully
|
|
322
|
+
# have [Operation.error][] value with a
|
|
323
|
+
# {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
|
|
324
|
+
# `Code.CANCELLED`.
|
|
325
|
+
# @!attribute [r] api_version
|
|
326
|
+
# @return [::String]
|
|
327
|
+
# Output only. API version used to start the operation.
|
|
328
|
+
class OperationMetadata
|
|
329
|
+
include ::Google::Protobuf::MessageExts
|
|
330
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
331
|
+
end
|
|
332
|
+
|
|
333
|
+
# A resource with its enrollment status.
|
|
334
|
+
# @!attribute [rw] name
|
|
335
|
+
# @return [::String]
|
|
336
|
+
# Identifier. The name of this resource.
|
|
337
|
+
# @!attribute [r] enrollment
|
|
338
|
+
# @return [::Google::Cloud::AuditManager::V1::Enrollment]
|
|
339
|
+
# Output only. Enrollment which contains enrolled destination details for a
|
|
340
|
+
# resource
|
|
341
|
+
# @!attribute [r] enrolled
|
|
342
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
343
|
+
# @return [::Boolean]
|
|
344
|
+
# Output only. Is resource enrolled.
|
|
345
|
+
# @!attribute [r] display_name
|
|
346
|
+
# @return [::String]
|
|
347
|
+
# Output only. Display name of the project/folder/organization.
|
|
348
|
+
# @!attribute [r] enrollment_state
|
|
349
|
+
# @return [::Google::Cloud::AuditManager::V1::ResourceEnrollmentStatus::ResourceEnrollmentState]
|
|
350
|
+
# Output only. Enrollment state of the resource.
|
|
351
|
+
class ResourceEnrollmentStatus
|
|
352
|
+
include ::Google::Protobuf::MessageExts
|
|
353
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
354
|
+
|
|
355
|
+
# The different enrollment states of a resource.
|
|
356
|
+
module ResourceEnrollmentState
|
|
357
|
+
# Unspecified. Invalid state.
|
|
358
|
+
RESOURCE_ENROLLMENT_STATE_UNSPECIFIED = 0
|
|
359
|
+
|
|
360
|
+
# Not enrolled.
|
|
361
|
+
NOT_ENROLLED = 1
|
|
362
|
+
|
|
363
|
+
# Resource is not enrolled but the parent is enrolled.
|
|
364
|
+
INHERITED = 2
|
|
365
|
+
|
|
366
|
+
# Enrolled.
|
|
367
|
+
ENROLLED = 3
|
|
368
|
+
end
|
|
369
|
+
end
|
|
370
|
+
|
|
371
|
+
# An audit report.
|
|
372
|
+
# @!attribute [rw] name
|
|
373
|
+
# @return [::String]
|
|
374
|
+
# Identifier. The name of this Audit Report, in the format of scope given in
|
|
375
|
+
# request.
|
|
376
|
+
# @!attribute [r] report_summary
|
|
377
|
+
# @return [::Google::Cloud::AuditManager::V1::ReportSummary]
|
|
378
|
+
# Output only. Report summary with compliance, violation counts etc.
|
|
379
|
+
# @!attribute [r] operation_id
|
|
380
|
+
# @return [::String]
|
|
381
|
+
# Output only. ClientOperationId
|
|
382
|
+
# @!attribute [r] destination_details
|
|
383
|
+
# @return [::Google::Cloud::AuditManager::V1::DestinationDetails]
|
|
384
|
+
# Output only. The location where the generated report will be uploaded.
|
|
385
|
+
# @!attribute [r] compliance_standard
|
|
386
|
+
# @return [::String]
|
|
387
|
+
# Output only. Compliance Standard.
|
|
388
|
+
# @!attribute [r] scope
|
|
389
|
+
# @return [::String]
|
|
390
|
+
# Output only. The parent scope on which the report was generated.
|
|
391
|
+
# @!attribute [r] create_time
|
|
392
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
393
|
+
# Output only. Creation time of the audit report.
|
|
394
|
+
# @!attribute [r] control_details
|
|
395
|
+
# @return [::Array<::Google::Cloud::AuditManager::V1::ControlDetails>]
|
|
396
|
+
# Output only. The overall status of controls
|
|
397
|
+
# @!attribute [r] report_generation_state
|
|
398
|
+
# @return [::Google::Cloud::AuditManager::V1::AuditReport::ReportGenerationState]
|
|
399
|
+
# Output only. The state of Audit Report Generation.
|
|
400
|
+
# @!attribute [r] compliance_framework
|
|
401
|
+
# @return [::String]
|
|
402
|
+
# Output only. Compliance Framework of Audit Report
|
|
403
|
+
# @!attribute [r] scope_id
|
|
404
|
+
# @return [::String]
|
|
405
|
+
# Output only. The ID/ Number for the scope on which the audit report was
|
|
406
|
+
# generated.
|
|
407
|
+
class AuditReport
|
|
408
|
+
include ::Google::Protobuf::MessageExts
|
|
409
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
410
|
+
|
|
411
|
+
# The different states of the Audit Manager report generation.
|
|
412
|
+
module ReportGenerationState
|
|
413
|
+
# Unspecified. Invalid state.
|
|
414
|
+
REPORT_GENERATION_STATE_UNSPECIFIED = 0
|
|
415
|
+
|
|
416
|
+
# Audit report generation process is in progress, ie. operation state is
|
|
417
|
+
# neither OPERATION_STATE_DONE nor OPERATION_STATE_FAILED.
|
|
418
|
+
IN_PROGRESS = 1
|
|
419
|
+
|
|
420
|
+
# Audit report generation process is completed. Operation state is
|
|
421
|
+
# OPERATION_STATE_DONE.
|
|
422
|
+
COMPLETED = 2
|
|
423
|
+
|
|
424
|
+
# Audit report generation process has failed. Operation state is
|
|
425
|
+
# OPERATION_STATE_FAILED.
|
|
426
|
+
FAILED = 3
|
|
427
|
+
|
|
428
|
+
# Audit report generation process has completed. But report summary is
|
|
429
|
+
# unknown. This is valid for older reports.
|
|
430
|
+
SUMMARY_UNKNOWN = 4
|
|
431
|
+
end
|
|
432
|
+
end
|
|
433
|
+
|
|
434
|
+
# The regulatory family of the control.
|
|
435
|
+
# @!attribute [rw] family_id
|
|
436
|
+
# @return [::String]
|
|
437
|
+
# The ID of the regulatory control family.
|
|
438
|
+
# @!attribute [rw] display_name
|
|
439
|
+
# @return [::String]
|
|
440
|
+
# The display name of the regulatory control family.
|
|
441
|
+
class ControlFamily
|
|
442
|
+
include ::Google::Protobuf::MessageExts
|
|
443
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
444
|
+
end
|
|
445
|
+
|
|
446
|
+
# A control.
|
|
447
|
+
# @!attribute [r] id
|
|
448
|
+
# @return [::String]
|
|
449
|
+
# Output only. The control identifier used to fetch the findings. This is
|
|
450
|
+
# same as the control report name.
|
|
451
|
+
# @!attribute [r] display_name
|
|
452
|
+
# @return [::String]
|
|
453
|
+
# Output only. Display name of the control.
|
|
454
|
+
# @!attribute [r] family
|
|
455
|
+
# @return [::Google::Cloud::AuditManager::V1::Control::Family]
|
|
456
|
+
# Output only. Group where the control belongs. E.g. Access Control.
|
|
457
|
+
# @!attribute [r] control_family
|
|
458
|
+
# @return [::Google::Cloud::AuditManager::V1::ControlFamily]
|
|
459
|
+
# Output only. Regulatory Family of the control E.g. Access Control
|
|
460
|
+
# @!attribute [r] description
|
|
461
|
+
# @return [::String]
|
|
462
|
+
# Output only. Regulatory control ask of the control
|
|
463
|
+
# @!attribute [r] responsibility_type
|
|
464
|
+
# @return [::String]
|
|
465
|
+
# Output only. The type of responsibility for implementing this control. It
|
|
466
|
+
# can be google, customer or shared.
|
|
467
|
+
# @!attribute [r] google_responsibility_description
|
|
468
|
+
# @return [::String]
|
|
469
|
+
# Output only. Description of the google responsibility for implementing this
|
|
470
|
+
# control.
|
|
471
|
+
# @!attribute [r] google_responsibility_implementation
|
|
472
|
+
# @return [::String]
|
|
473
|
+
# Output only. Implementation of the google responsibility for implementing
|
|
474
|
+
# this control.
|
|
475
|
+
# @!attribute [r] customer_responsibility_description
|
|
476
|
+
# @return [::String]
|
|
477
|
+
# Output only. Description of the customer responsibility for implementing
|
|
478
|
+
# this control.
|
|
479
|
+
# @!attribute [r] customer_responsibility_implementation
|
|
480
|
+
# @return [::String]
|
|
481
|
+
# Output only. Implementation of the customer responsibility for implementing
|
|
482
|
+
# this control.
|
|
483
|
+
class Control
|
|
484
|
+
include ::Google::Protobuf::MessageExts
|
|
485
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
486
|
+
|
|
487
|
+
# The family of the control. For example, Access Control.
|
|
488
|
+
module Family
|
|
489
|
+
# Unspecified. Invalid state.
|
|
490
|
+
FAMILY_UNSPECIFIED = 0
|
|
491
|
+
|
|
492
|
+
# Access Control
|
|
493
|
+
AC = 1
|
|
494
|
+
|
|
495
|
+
# Awareness and Training
|
|
496
|
+
AT = 2
|
|
497
|
+
|
|
498
|
+
# Audit and Accountability
|
|
499
|
+
AU = 3
|
|
500
|
+
|
|
501
|
+
# Certification, Accreditation and Security Assessments
|
|
502
|
+
CA = 4
|
|
503
|
+
|
|
504
|
+
# Configuration Management
|
|
505
|
+
CM = 5
|
|
506
|
+
|
|
507
|
+
# Contingency Planning
|
|
508
|
+
CP = 6
|
|
509
|
+
|
|
510
|
+
# Identification and Authentication
|
|
511
|
+
IA = 7
|
|
512
|
+
|
|
513
|
+
# Incident Response
|
|
514
|
+
IR = 8
|
|
515
|
+
|
|
516
|
+
# Maintenance
|
|
517
|
+
MA = 9
|
|
518
|
+
|
|
519
|
+
# Media Protection
|
|
520
|
+
MP = 10
|
|
521
|
+
|
|
522
|
+
# Physical and Environmental Protection
|
|
523
|
+
PE = 11
|
|
524
|
+
|
|
525
|
+
# Security Planning
|
|
526
|
+
PL = 12
|
|
527
|
+
|
|
528
|
+
# Personnel Security
|
|
529
|
+
PS = 13
|
|
530
|
+
|
|
531
|
+
# Risk Assessment
|
|
532
|
+
RA = 14
|
|
533
|
+
|
|
534
|
+
# System Services and Acquisition
|
|
535
|
+
SA = 15
|
|
536
|
+
|
|
537
|
+
# System and Communications Protection
|
|
538
|
+
SC = 16
|
|
539
|
+
|
|
540
|
+
# System and Information Integrity
|
|
541
|
+
SI = 17
|
|
542
|
+
|
|
543
|
+
# Supply Chain Risk Management
|
|
544
|
+
SR = 18
|
|
545
|
+
end
|
|
546
|
+
end
|
|
547
|
+
|
|
548
|
+
# The locations where the generated reports are saved.
|
|
549
|
+
# @!attribute [rw] gcs_bucket_uri
|
|
550
|
+
# @return [::String]
|
|
551
|
+
# The Cloud Storage bucket where the audit report is/will be uploaded.
|
|
552
|
+
class DestinationDetails
|
|
553
|
+
include ::Google::Protobuf::MessageExts
|
|
554
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
555
|
+
end
|
|
556
|
+
|
|
557
|
+
# The additional information for an audit operation.
|
|
558
|
+
# @!attribute [rw] total_count
|
|
559
|
+
# @return [::Integer]
|
|
560
|
+
# Total number of checks.
|
|
561
|
+
# @!attribute [rw] compliant_count
|
|
562
|
+
# @return [::Integer]
|
|
563
|
+
# Number of compliant checks.
|
|
564
|
+
# @!attribute [rw] violation_count
|
|
565
|
+
# @return [::Integer]
|
|
566
|
+
# Number of checks with violations.
|
|
567
|
+
# @!attribute [rw] manual_review_needed_count
|
|
568
|
+
# @return [::Integer]
|
|
569
|
+
# Number of checks with "manual review needed" status.
|
|
570
|
+
# @!attribute [rw] error_count
|
|
571
|
+
# @return [::Integer]
|
|
572
|
+
# Number of checks that could not be performed due to errors.
|
|
573
|
+
class ReportSummary
|
|
574
|
+
include ::Google::Protobuf::MessageExts
|
|
575
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
576
|
+
end
|
|
577
|
+
|
|
578
|
+
# The evaluation details for a control.
|
|
579
|
+
# @!attribute [rw] control
|
|
580
|
+
# @return [::Google::Cloud::AuditManager::V1::Control]
|
|
581
|
+
# The control for which the findings are being reported.
|
|
582
|
+
# @!attribute [r] compliance_state
|
|
583
|
+
# @return [::Google::Cloud::AuditManager::V1::ComplianceState]
|
|
584
|
+
# Output only. Overall status of the findings for the control.
|
|
585
|
+
# @!attribute [rw] control_report_summary
|
|
586
|
+
# @return [::Google::Cloud::AuditManager::V1::ReportSummary]
|
|
587
|
+
# Report summary with compliance, violation counts etc.
|
|
588
|
+
class ControlDetails
|
|
589
|
+
include ::Google::Protobuf::MessageExts
|
|
590
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
591
|
+
end
|
|
592
|
+
|
|
593
|
+
# The different execution states of the Audit Manager service.
|
|
594
|
+
module OperationState
|
|
595
|
+
# Unspecified. Invalid state.
|
|
596
|
+
OPERATION_STATE_UNSPECIFIED = 0
|
|
597
|
+
|
|
598
|
+
# Audit report generation process has not started.
|
|
599
|
+
OPERATION_STATE_NOT_STARTED = 10
|
|
600
|
+
|
|
601
|
+
# Audit Manager is currently evaluating the workloads against specific
|
|
602
|
+
# standard.
|
|
603
|
+
OPERATION_STATE_EVALUATION_IN_PROGRESS = 20
|
|
604
|
+
|
|
605
|
+
# Audit Manager has completed Evaluation for the workload.
|
|
606
|
+
OPERATION_STATE_EVALUATION_DONE = 21
|
|
607
|
+
|
|
608
|
+
# Audit Manager is creating audit report from the evaluated data.
|
|
609
|
+
OPERATION_STATE_EVIDENCE_REPORT_GENERATION_IN_PROGRESS = 30
|
|
610
|
+
|
|
611
|
+
# Audit Manager has completed generation of the audit report.
|
|
612
|
+
OPERATION_STATE_EVIDENCE_REPORT_GENERATION_DONE = 31
|
|
613
|
+
|
|
614
|
+
# Audit Manager is uploading the audit report and evidences to the customer
|
|
615
|
+
# provided destination.
|
|
616
|
+
OPERATION_STATE_EVIDENCE_UPLOAD_IN_PROGRESS = 40
|
|
617
|
+
|
|
618
|
+
# Audit report generation process is completed.
|
|
619
|
+
OPERATION_STATE_DONE = 50
|
|
620
|
+
|
|
621
|
+
# Audit report generation process has failed.
|
|
622
|
+
OPERATION_STATE_FAILED = 60
|
|
623
|
+
end
|
|
624
|
+
|
|
625
|
+
# The compliance state after evaluation.
|
|
626
|
+
module ComplianceState
|
|
627
|
+
# Unspecified. Invalid state.
|
|
628
|
+
COMPLIANCE_STATE_UNSPECIFIED = 0
|
|
629
|
+
|
|
630
|
+
# Compliant.
|
|
631
|
+
COMPLIANT = 1
|
|
632
|
+
|
|
633
|
+
# Violation.
|
|
634
|
+
VIOLATION = 2
|
|
635
|
+
|
|
636
|
+
# MANUAL_REVIEW_NEEDED, requires manual review
|
|
637
|
+
MANUAL_REVIEW_NEEDED = 3
|
|
638
|
+
|
|
639
|
+
# Error while computing status.
|
|
640
|
+
ERROR = 4
|
|
641
|
+
|
|
642
|
+
# Cannot be audited
|
|
643
|
+
AUDIT_NOT_SUPPORTED = 5
|
|
644
|
+
end
|
|
645
|
+
end
|
|
646
|
+
end
|
|
647
|
+
end
|
|
648
|
+
end
|