google-cloud-audit_manager-v1 1.0.1 → 1.1.1

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 (13) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -2
  3. data/lib/google/cloud/audit_manager/v1/audit_manager/client.rb +126 -70
  4. data/lib/google/cloud/audit_manager/v1/audit_manager/credentials.rb +1 -0
  5. data/lib/google/cloud/audit_manager/v1/audit_manager/paths.rb +32 -0
  6. data/lib/google/cloud/audit_manager/v1/audit_manager/rest/client.rb +126 -70
  7. data/lib/google/cloud/audit_manager/v1/audit_manager/rest/service_stub.rb +23 -0
  8. data/lib/google/cloud/audit_manager/v1/version.rb +1 -1
  9. data/lib/google/cloud/auditmanager/v1/auditmanager_pb.rb +1 -1
  10. data/lib/google/cloud/auditmanager/v1/auditmanager_services_pb.rb +24 -15
  11. data/proto_docs/google/cloud/auditmanager/v1/auditmanager.rb +314 -221
  12. data/proto_docs/google/protobuf/timestamp.rb +7 -6
  13. metadata +5 -5
data/proto_docs/google/cloud/auditmanager/v1/auditmanager.rb CHANGED
@@ -21,349 +21,426 @@ module Google
21
21
  module Cloud
22
22
  module AuditManager
23
23
  module V1
24
- # Request message to subscribe the Audit Manager service for given resource.
24
+ # Request message for
25
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#enroll_resource EnrollResource}.
25
26
  # @!attribute [rw] scope
26
27
  # @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}
28
+ # Required. Organization, folder, or project to enroll in Audit Manager, in
29
+ # one of the following formats:
30
+ #
31
+ # * `projects/{project}/locations/{location}`
32
+ # * `folders/{folder}/locations/{location}`
33
+ # * `organizations/{organization}/locations/{location}`
32
34
  # @!attribute [rw] destinations
33
35
  # @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.
36
+ # Required. Cloud Storage buckets that you can upload your audit reports to
37
+ # during the audit process.
38
+ #
39
+ # When you enroll an organization or folder, you can choose a Cloud Storage
40
+ # bucket from any project in the organization or folder. If you run an audit
41
+ # at the project level using the service agent at the organization or folder
42
+ # level, all the buckets that are associated with the service agent are
43
+ # available.
41
44
  class EnrollResourceRequest
42
45
  include ::Google::Protobuf::MessageExts
43
46
  extend ::Google::Protobuf::MessageExts::ClassMethods
44
47
 
45
- # The destination details where the audit report must be uploaded.
48
+ # Details about the bucket where you want to upload the audit report.
46
49
  # @!attribute [rw] eligible_gcs_bucket
47
50
  # @return [::String]
48
- # The Cloud Storage bucket location where the audit report and evidences
49
- # can be uploaded during the `GenerateAuditReport` API call.
51
+ # The location of the Cloud Storage bucket where you want to upload the
52
+ # audit report and evidence during the
53
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#generate_audit_report GenerateAuditReport}
54
+ # API call.
50
55
  class EligibleDestination
51
56
  include ::Google::Protobuf::MessageExts
52
57
  extend ::Google::Protobuf::MessageExts::ClassMethods
53
58
  end
54
59
  end
55
60
 
56
- # Message for requesting audit scope report.
61
+ # Request message for
62
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#generate_audit_scope_report GenerateAuditScopeReport}.
57
63
  # @!attribute [rw] scope
58
64
  # @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}
65
+ # Required. Project or folder that the audit scope report is generated for,
66
+ # in one of the following formats:
67
+ #
68
+ # * `projects/{project}/locations/{location}`
69
+ # * `folders/{folder}/locations/{location}`
70
+ # * `organizations/{organization}/locations/{location}`
63
71
  # @!attribute [rw] compliance_standard
72
+ # @deprecated This field is deprecated and may be removed in the next major version update.
64
73
  # @return [::String]
65
- # Required. Compliance Standard against which the Scope Report must be
66
- # generated. Eg: FEDRAMP_MODERATE
74
+ # Optional. Deprecated. The standard (industry or regulatory requirements)
75
+ # that the audit scope report is run against.
76
+ #
77
+ # Use the `compliance_framework` field instead.
67
78
  # @!attribute [rw] report_format
68
79
  # @return [::Google::Cloud::AuditManager::V1::GenerateAuditScopeReportRequest::AuditScopeReportFormat]
69
- # Required. The format in which the Scope report bytes should be returned.
80
+ # Required. Format for the audit scope report.
70
81
  # @!attribute [rw] compliance_framework
71
82
  # @return [::String]
72
- # Required. Compliance framework against which the Scope Report must be
73
- # generated.
83
+ # Required. Framework (set of controls) that the audit scope report is
84
+ # generated against. For example, `NIST_800_53`.
74
85
  class GenerateAuditScopeReportRequest
75
86
  include ::Google::Protobuf::MessageExts
76
87
  extend ::Google::Protobuf::MessageExts::ClassMethods
77
88
 
78
- # The options for the audit scope report format.
89
+ # Format for the audit scope report.
79
90
  module AuditScopeReportFormat
80
- # Unspecified. Invalid format.
91
+ # Default value. This value is unused.
81
92
  AUDIT_SCOPE_REPORT_FORMAT_UNSPECIFIED = 0
82
93
 
83
- # Audit Scope Report creation format is Open Document.
94
+ # Open Document format.
84
95
  AUDIT_SCOPE_REPORT_FORMAT_ODF = 1
85
96
  end
86
97
  end
87
98
 
88
- # Message for requesting the Audit Report.
99
+ # Request message for
100
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#generate_audit_report GenerateAuditReport}.
89
101
  # @!attribute [rw] gcs_uri
90
102
  # @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.
103
+ # URL for the Cloud Storage bucket where the report and evidence is
104
+ # uploaded. You must select a bucket that was provided during the
105
+ # enrollment process.
94
106
  # @!attribute [rw] scope
95
107
  # @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}
108
+ # Required. Organization, folder, or project that the audit applies to, in
109
+ # one of the following formats:
110
+ #
111
+ # * `projects/{project}/locations/{location}`
112
+ # * `folders/{folder}/locations/{location}`
113
+ # * `organizations/{organization}/locations/{location}`
100
114
  # @!attribute [rw] compliance_standard
115
+ # @deprecated This field is deprecated and may be removed in the next major version update.
101
116
  # @return [::String]
102
- # Required. Compliance Standard against which the Scope Report must be
103
- # generated. Eg: FEDRAMP_MODERATE
117
+ # Optional. Deprecated. Compliance standard for the audit report.
118
+ #
119
+ # Use the `compliance_framework` field instead.
104
120
  # @!attribute [rw] report_format
105
121
  # @return [::Google::Cloud::AuditManager::V1::GenerateAuditReportRequest::AuditReportFormat]
106
- # Required. The format in which the audit report should be created.
122
+ # Required. Format for the audit report.
107
123
  # @!attribute [rw] compliance_framework
108
124
  # @return [::String]
109
- # Required. Compliance framework against which the Report must be generated.
125
+ # Required. The framework that's used for the audit report. For example,
126
+ # `NIST_800_53`.
127
+ # @!attribute [rw] validate_only
128
+ # @return [::Boolean]
129
+ # Optional. If `true`, only validates the request and does not generate the
130
+ # audit report. This executes standard request validation (such as schema,
131
+ # framework existence, scope, and IAM checks) and skips the apply phase.
132
+ #
133
+ # Use this field for the following purposes:
134
+ # * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run
135
+ # dry-run mutations (e.g., `terraform plan`) without creating real
136
+ # resources or incurring costs.
137
+ # * **User Interface Validation**: Enable real-time form and permission
138
+ # validation in custom UIs before submitting requests.
139
+ # * **CI/CD & Automation**: Test your scripts, permissions, and parameters
140
+ # safely without triggering expensive Long-Running Operations (LROs) or
141
+ # consuming resource quotas.
110
142
  class GenerateAuditReportRequest
111
143
  include ::Google::Protobuf::MessageExts
112
144
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
145
 
114
- # The options for the audit report format.
146
+ # Format for the audit report.
115
147
  module AuditReportFormat
116
- # Unspecified. Invalid state.
148
+ # Default value. This value is unused.
117
149
  AUDIT_REPORT_FORMAT_UNSPECIFIED = 0
118
150
 
119
- # Audit Report creation format is Open Document.
151
+ # Open Document format.
120
152
  AUDIT_REPORT_FORMAT_ODF = 1
121
153
  end
122
154
  end
123
155
 
124
- # Message for getting the enrollment status of a resource.
156
+ # Request message for
157
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#get_resource_enrollment_status GetResourceEnrollmentStatus}.
125
158
  # @!attribute [rw] name
126
159
  # @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}
160
+ # Required. Name of the resource enrollment status, in one of the following
161
+ # formats:
162
+ #
163
+ # * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
164
+ # * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
165
+ # * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
131
166
  class GetResourceEnrollmentStatusRequest
132
167
  include ::Google::Protobuf::MessageExts
133
168
  extend ::Google::Protobuf::MessageExts::ClassMethods
134
169
  end
135
170
 
136
- # Message for listing all the descendent resources under parent with
137
- # enrollment.
171
+ # Request message for
172
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#list_resource_enrollment_statuses ListResourceEnrollmentStatuses}.
138
173
  # @!attribute [rw] parent
139
174
  # @return [::String]
140
- # Required. The parent scope for which the list of resources with enrollments
141
- # are required.
175
+ # Required. Parent organization or folder to list enrollment statuses for,
176
+ # in one of the following formats:
177
+ #
178
+ # * `folders/{folder}/locations/{location}`
179
+ # * `organizations/{organization}/locations/{location}`
142
180
  # @!attribute [rw] page_size
143
181
  # @return [::Integer]
144
- # Optional. The maximum number of resources to return.
182
+ # Optional. Maximum number of items to return in a single page. The service
183
+ # might return fewer items than this value. If unspecified, the service picks
184
+ # an appropriate default. The maximum value is 100; values above 100 are
185
+ # reduced to 100.
145
186
  # @!attribute [rw] page_token
146
187
  # @return [::String]
147
- # Optional. The next_page_token value returned from a previous List request,
148
- # if any.
188
+ # Optional. A page token, received from a previous call, to retrieve the next
189
+ # page of results.
149
190
  class ListResourceEnrollmentStatusesRequest
150
191
  include ::Google::Protobuf::MessageExts
151
192
  extend ::Google::Protobuf::MessageExts::ClassMethods
152
193
  end
153
194
 
154
- # Response message with all the descendent resources with enrollment.
195
+ # Response message for
196
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#list_resource_enrollment_statuses ListResourceEnrollmentStatuses}.
155
197
  # @!attribute [rw] resource_enrollment_statuses
156
198
  # @return [::Array<::Google::Cloud::AuditManager::V1::ResourceEnrollmentStatus>]
157
- # The resources with their enrollment status.
199
+ # Resources with their enrollment status.
158
200
  # @!attribute [r] next_page_token
159
201
  # @return [::String]
160
- # Output only. The token to retrieve the next page of results.
202
+ # Output only. A token that you can send as the `page_token` in a subsequent
203
+ # request to retrieve the next page of results. If this field is empty, there
204
+ # are no subsequent pages.
161
205
  class ListResourceEnrollmentStatusesResponse
162
206
  include ::Google::Protobuf::MessageExts
163
207
  extend ::Google::Protobuf::MessageExts::ClassMethods
164
208
  end
165
209
 
166
- # Message for requesting to list the audit reports.
210
+ # Request message for
211
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#list_audit_reports ListAuditReports}.
167
212
  # @!attribute [rw] parent
168
213
  # @return [::String]
169
- # Required. The parent scope for which to list the reports.
214
+ # Required. Parent organization, folder, or project to list reports for,
215
+ # in one of the following formats:
216
+ #
217
+ # * `projects/{project}/locations/{location}`
218
+ # * `folders/{folder}/locations/{location}`
219
+ # * `organizations/{organization}/locations/{location}`
170
220
  # @!attribute [rw] page_size
171
221
  # @return [::Integer]
172
- # Optional. The maximum number of resources to return.
222
+ # Optional. Maximum number of items to return in a single page. The service
223
+ # might return fewer items than this value. If unspecified, the service picks
224
+ # an appropriate default. The maximum value is 100; values above 100 are
225
+ # reduced to 100.
173
226
  # @!attribute [rw] page_token
174
227
  # @return [::String]
175
- # Optional. The next_page_token value returned from a previous List request,
176
- # if any.
228
+ # Optional. A page token, received from a previous call, to retrieve the next
229
+ # page of results.
177
230
  class ListAuditReportsRequest
178
231
  include ::Google::Protobuf::MessageExts
179
232
  extend ::Google::Protobuf::MessageExts::ClassMethods
180
233
  end
181
234
 
182
- # Response message with all the audit reports.
235
+ # Response message for
236
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#list_audit_reports ListAuditReports}.
183
237
  # @!attribute [r] audit_reports
184
238
  # @return [::Array<::Google::Cloud::AuditManager::V1::AuditReport>]
185
- # Output only. The audit reports.
239
+ # Output only. Audit reports.
186
240
  # @!attribute [r] next_page_token
187
241
  # @return [::String]
188
- # Output only. The token to retrieve the next page of results.
242
+ # Output only. A token that you can send as the `page_token` in a subsequent
243
+ # request to retrieve the next page of results. If this field is empty, there
244
+ # are no subsequent pages.
189
245
  class ListAuditReportsResponse
190
246
  include ::Google::Protobuf::MessageExts
191
247
  extend ::Google::Protobuf::MessageExts::ClassMethods
192
248
  end
193
249
 
194
- # Message for requesting the overall audit report for an audit report name.
250
+ # Request message for
251
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#get_audit_report GetAuditReport}.
195
252
  # @!attribute [rw] name
196
253
  # @return [::String]
197
- # Required. Format
198
- # projects/\\{project}/locations/\\{location}/auditReports/\\{audit_report},
199
- # folders/\\{folder}/locations/\\{location}/auditReports/\\{audit_report}
254
+ # Required. Name of the audit report, in one of the following formats:
255
+ #
256
+ # * `projects/{project}/locations/{location}/auditReports/{audit_report}`
257
+ # * `folders/{folder}/locations/{location}/auditReports/{audit_report}`
258
+ # * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
200
259
  class GetAuditReportRequest
201
260
  include ::Google::Protobuf::MessageExts
202
261
  extend ::Google::Protobuf::MessageExts::ClassMethods
203
262
  end
204
263
 
205
- # Message for requesting all the controls for a compliance standard.
264
+ # Request message for
265
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#list_controls ListControls}.
206
266
  # @!attribute [rw] parent
207
267
  # @return [::String]
208
- # Required. Format
209
- # projects/\\{project}/locations/\\{location}/standards/\\{standard},
210
- # folders/\\{folder}/locations/\\{location}/standards/\\{standard}
268
+ # Required. Standard to list controls for, in one of the following formats:
269
+ #
270
+ # * `projects/{project}/locations/{location}/standards/{standard}`
271
+ # * `folders/{folder}/locations/{location}/standards/{standard}`
272
+ # * `organizations/{organization}/locations/{location}/standards/{standard}`
211
273
  # @!attribute [rw] page_size
212
274
  # @return [::Integer]
213
- # Optional. The maximum number of resources to return.
275
+ # Optional. Maximum number of items to return in a single page. The service
276
+ # might return fewer items than this value. If unspecified, the service picks
277
+ # an appropriate default. The maximum value is 100; values above 100 are
278
+ # reduced to 100.
214
279
  # @!attribute [rw] page_token
215
280
  # @return [::String]
216
- # Optional. The next_page_token value returned from a previous List request,
217
- # if any.
281
+ # Optional. A page token, received from a previous call, to retrieve the next
282
+ # page of results.
218
283
  class ListControlsRequest
219
284
  include ::Google::Protobuf::MessageExts
220
285
  extend ::Google::Protobuf::MessageExts::ClassMethods
221
286
  end
222
287
 
223
- # Response message with all the controls for a compliance standard.
288
+ # Response message for
289
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#list_controls ListControls}.
224
290
  # @!attribute [r] controls
225
291
  # @return [::Array<::Google::Cloud::AuditManager::V1::Control>]
226
- # Output only. The controls for the compliance standard.
292
+ # Output only. Controls for a given regulatory standard.
227
293
  # @!attribute [r] next_page_token
228
294
  # @return [::String]
229
- # Output only. The token to retrieve the next page of results.
295
+ # Output only. A token that you can send as the `page_token` in a subsequent
296
+ # request to retrieve the next page of results. If this field is empty, there
297
+ # are no subsequent pages.
230
298
  class ListControlsResponse
231
299
  include ::Google::Protobuf::MessageExts
232
300
  extend ::Google::Protobuf::MessageExts::ClassMethods
233
301
  end
234
302
 
235
- # The `ReportGenerationProgress` is part of
236
- # {::Google::Longrunning::Operation google.longrunning.Operation} returned to the
237
- # client for every `GetOperation` request.
303
+ # Details about the current status of the report-generation process.
238
304
  # @!attribute [r] state
239
305
  # @return [::Google::Cloud::AuditManager::V1::OperationState]
240
- # Output only. The current state of execution for report generation.
306
+ # Output only. Current state of execution for report generation.
241
307
  # @!attribute [r] failure_reason
242
308
  # @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.
309
+ # Output only. Reason for failure during the audit report generation process.
310
+ # This field is set only if the `OperationState` attribute is
311
+ # `OPERATION_STATE_FAILED`.
246
312
  # @!attribute [rw] evaluation_percent_complete
247
313
  # @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.
314
+ # Progress of the evaluation process. The progress is
315
+ # defined in terms of percentage complete.
251
316
  # @!attribute [rw] report_generation_percent_complete
252
317
  # @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%.
318
+ # Report generation progress, defined in terms of percentage complete.
319
+ # Until evaluation is complete, this value is always `0`.
257
320
  # @!attribute [rw] report_uploading_percent_complete
258
321
  # @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%.
322
+ # Report uploading progress, defined in terms of percentage complete.
323
+ # Until evaluation and report generation are complete, this value is always
324
+ # `0`.
264
325
  # @!attribute [r] destination_gcs_bucket
265
326
  # @return [::String]
266
- # Output only. The Cloud Storage bucket where the audit report will be
267
- # uploaded once the evaluation process is completed.
327
+ # Output only. Cloud Storage bucket where the audit report is uploaded to
328
+ # after the evaluation process is completed.
268
329
  # @!attribute [r] audit_report
269
330
  # @return [::String]
270
- # Output only. The name of the audit report.
331
+ # Output only. Name of the audit report.
271
332
  class ReportGenerationProgress
272
333
  include ::Google::Protobuf::MessageExts
273
334
  extend ::Google::Protobuf::MessageExts::ClassMethods
274
335
  end
275
336
 
276
- # The enrollment resource.
337
+ # Organization, folder, or project to enroll for audit reports.
277
338
  # @!attribute [rw] name
278
339
  # @return [::String]
279
- # Identifier. The name of this Enrollment, in the format of scope given in
280
- # request.
340
+ # Identifier. Name of the enrollment, in one of the following formats:
341
+ #
342
+ # * `projects/{project}/locations/{location}/enrollments/{enrollment}`
343
+ # * `folders/{folder}/locations/{location}/enrollments/{enrollment}`
344
+ # * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`
281
345
  # @!attribute [r] destination_details
282
346
  # @return [::Array<::Google::Cloud::AuditManager::V1::DestinationDetails>]
283
- # Output only. The locations where the generated reports can be uploaded.
347
+ # Output only. Cloud Storage buckets where you want to upload the audit
348
+ # reports.
284
349
  class Enrollment
285
350
  include ::Google::Protobuf::MessageExts
286
351
  extend ::Google::Protobuf::MessageExts::ClassMethods
287
352
  end
288
353
 
289
- # The audit scope report.
354
+ # Audit scope report.
290
355
  # @!attribute [rw] scope_report_contents
291
356
  # @return [::String]
292
- # The audit scope report content in byte format.
357
+ # Audit scope report content in byte format.
293
358
  # @!attribute [rw] name
294
359
  # @return [::String]
295
- # Identifier. The name of this Audit Report, in the format of scope given in
296
- # request.
360
+ # Identifier. Name for the audit scope report, in one of the following
361
+ # formats:
362
+ #
363
+ # * `projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}`
364
+ # * `folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_report}`
365
+ # * `organizations/{organization}/locations/{location}/auditScopeReports/{audit_scope_report}`
297
366
  class AuditScopeReport
298
367
  include ::Google::Protobuf::MessageExts
299
368
  extend ::Google::Protobuf::MessageExts::ClassMethods
300
369
  end
301
370
 
302
- # The metadata of the long-running operation.
371
+ # Metadata for the long-running operation.
303
372
  # @!attribute [r] create_time
304
373
  # @return [::Google::Protobuf::Timestamp]
305
- # Output only. The time the operation was created.
374
+ # Output only. Time that the operation was created.
306
375
  # @!attribute [r] end_time
307
376
  # @return [::Google::Protobuf::Timestamp]
308
- # Output only. The time the operation finished running.
377
+ # Output only. Time that the operation finished running.
309
378
  # @!attribute [r] target
310
379
  # @return [::String]
311
- # Output only. Server-defined resource path for the target of the operation.
380
+ # Output only. A server-defined resource path for the target of the
381
+ # operation.
312
382
  # @!attribute [r] verb
313
383
  # @return [::String]
314
- # Output only. Name of the verb executed by the operation.
384
+ # Output only. The name of the verb that was executed by the operation.
315
385
  # @!attribute [r] status_message
316
386
  # @return [::String]
317
- # Output only. Human-readable status of the operation, if any.
387
+ # Output only. A human-readable status of the operation, if any.
318
388
  # @!attribute [r] requested_cancellation
319
389
  # @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`.
390
+ # Output only. Whether you requested that the operation be cancelled.
391
+ # Operations that were cancelled successfully have an
392
+ # {::Google::Longrunning::Operation#error Operation.error}
393
+ # value with a status code
394
+ # [Code.CANCELLED][google.rpc.Status.code.CANCELLED].
325
395
  # @!attribute [r] api_version
326
396
  # @return [::String]
327
- # Output only. API version used to start the operation.
397
+ # Output only. The API version used to start the operation. For example,
398
+ # `v1`.
328
399
  class OperationMetadata
329
400
  include ::Google::Protobuf::MessageExts
330
401
  extend ::Google::Protobuf::MessageExts::ClassMethods
331
402
  end
332
403
 
333
- # A resource with its enrollment status.
404
+ # An organization, folder, or project with its enrollment status.
334
405
  # @!attribute [rw] name
335
406
  # @return [::String]
336
- # Identifier. The name of this resource.
407
+ # Identifier. Name of the resource enrollment status, in one of the following
408
+ # formats:
409
+ #
410
+ # * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
411
+ # * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
412
+ # * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
337
413
  # @!attribute [r] enrollment
338
414
  # @return [::Google::Cloud::AuditManager::V1::Enrollment]
339
- # Output only. Enrollment which contains enrolled destination details for a
340
- # resource
415
+ # Output only. Enrolled destination details for the organization, folder, or
416
+ # project.
341
417
  # @!attribute [r] enrolled
342
418
  # @deprecated This field is deprecated and may be removed in the next major version update.
343
419
  # @return [::Boolean]
344
- # Output only. Is resource enrolled.
420
+ # Output only. Deprecated. Whether the organization, folder, or project is
421
+ # enrolled. Use `enrollment_state` instead.
345
422
  # @!attribute [r] display_name
346
423
  # @return [::String]
347
- # Output only. Display name of the project/folder/organization.
424
+ # Output only. Display name for the organization, folder, or project.
348
425
  # @!attribute [r] enrollment_state
349
426
  # @return [::Google::Cloud::AuditManager::V1::ResourceEnrollmentStatus::ResourceEnrollmentState]
350
- # Output only. Enrollment state of the resource.
427
+ # Output only. Enrollment state of the organization, folder, or project.
351
428
  class ResourceEnrollmentStatus
352
429
  include ::Google::Protobuf::MessageExts
353
430
  extend ::Google::Protobuf::MessageExts::ClassMethods
354
431
 
355
- # The different enrollment states of a resource.
432
+ # Different enrollment states of the resource and its parent.
356
433
  module ResourceEnrollmentState
357
- # Unspecified. Invalid state.
434
+ # Default value. This value is unused.
358
435
  RESOURCE_ENROLLMENT_STATE_UNSPECIFIED = 0
359
436
 
360
- # Not enrolled.
437
+ # The resource isn't enrolled.
361
438
  NOT_ENROLLED = 1
362
439
 
363
- # Resource is not enrolled but the parent is enrolled.
440
+ # The resource isn't enrolled but the parent is enrolled.
364
441
  INHERITED = 2
365
442
 
366
- # Enrolled.
443
+ # The resource is enrolled.
367
444
  ENROLLED = 3
368
445
  end
369
446
  end
@@ -371,73 +448,89 @@ module Google
371
448
  # An audit report.
372
449
  # @!attribute [rw] name
373
450
  # @return [::String]
374
- # Identifier. The name of this Audit Report, in the format of scope given in
375
- # request.
451
+ # Identifier. Name of the audit report, in one of the following formats:
452
+ #
453
+ # * `projects/{project}/locations/{location}/auditReports/{audit_report}`
454
+ # * `folders/{folder}/locations/{location}/auditReports/{audit_report}`
455
+ # * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
376
456
  # @!attribute [r] report_summary
377
457
  # @return [::Google::Cloud::AuditManager::V1::ReportSummary]
378
- # Output only. Report summary with compliance, violation counts etc.
458
+ # Output only. Report summary that includes information about compliance and
459
+ # violation counts.
379
460
  # @!attribute [r] operation_id
380
461
  # @return [::String]
381
- # Output only. ClientOperationId
462
+ # Output only. Client operation ID for the audit report.
382
463
  # @!attribute [r] destination_details
383
464
  # @return [::Google::Cloud::AuditManager::V1::DestinationDetails]
384
- # Output only. The location where the generated report will be uploaded.
465
+ # Output only. Cloud Storage bucket where the audit report is uploaded to.
385
466
  # @!attribute [r] compliance_standard
467
+ # @deprecated This field is deprecated and may be removed in the next major version update.
386
468
  # @return [::String]
387
- # Output only. Compliance Standard.
469
+ # Output only. Deprecated. Compliance standard to be audited against.
470
+ #
471
+ # Use the `compliance_framework` field instead.
388
472
  # @!attribute [r] scope
389
473
  # @return [::String]
390
- # Output only. The parent scope on which the report was generated.
474
+ # Output only. Organization, folder, or project that the report is generated
475
+ # for, in one of the following formats:
476
+ #
477
+ # * `projects/{project}/locations/{location}`
478
+ # * `folders/{folder}/locations/{location}`
479
+ # * `organizations/{organization}/locations/{location}`
391
480
  # @!attribute [r] create_time
392
481
  # @return [::Google::Protobuf::Timestamp]
393
482
  # Output only. Creation time of the audit report.
394
483
  # @!attribute [r] control_details
395
484
  # @return [::Array<::Google::Cloud::AuditManager::V1::ControlDetails>]
396
- # Output only. The overall status of controls
485
+ # Output only. Overall status of the controls.
397
486
  # @!attribute [r] report_generation_state
398
487
  # @return [::Google::Cloud::AuditManager::V1::AuditReport::ReportGenerationState]
399
- # Output only. The state of Audit Report Generation.
488
+ # Output only. State of audit report generation.
400
489
  # @!attribute [r] compliance_framework
401
490
  # @return [::String]
402
- # Output only. Compliance Framework of Audit Report
491
+ # Output only. Compliance framework to use for the audit report. For example,
492
+ # `CIS_GCP_FOUNDATIONS_V1_2_0`.
403
493
  # @!attribute [r] scope_id
404
494
  # @return [::String]
405
- # Output only. The ID/ Number for the scope on which the audit report was
406
- # generated.
495
+ # Output only. Project number, folder ID, or organization ID that the audit
496
+ # report was generated for.
407
497
  class AuditReport
408
498
  include ::Google::Protobuf::MessageExts
409
499
  extend ::Google::Protobuf::MessageExts::ClassMethods
410
500
 
411
- # The different states of the Audit Manager report generation.
501
+ # Different states of report generation.
412
502
  module ReportGenerationState
413
- # Unspecified. Invalid state.
503
+ # Default value. This value is unused.
414
504
  REPORT_GENERATION_STATE_UNSPECIFIED = 0
415
505
 
416
- # Audit report generation process is in progress, ie. operation state is
417
- # neither OPERATION_STATE_DONE nor OPERATION_STATE_FAILED.
506
+ # The process is in progress. The operation can have any state
507
+ # except for `OPERATION_STATE_DONE` or `OPERATION_STATE_FAILED`.
418
508
  IN_PROGRESS = 1
419
509
 
420
- # Audit report generation process is completed. Operation state is
421
- # OPERATION_STATE_DONE.
510
+ # The process is completed. The operation state is
511
+ # `OPERATION_STATE_DONE`.
422
512
  COMPLETED = 2
423
513
 
424
- # Audit report generation process has failed. Operation state is
425
- # OPERATION_STATE_FAILED.
514
+ # The process has failed. The operation state is
515
+ # `OPERATION_STATE_FAILED`.
426
516
  FAILED = 3
427
517
 
428
- # Audit report generation process has completed. But report summary is
429
- # unknown. This is valid for older reports.
518
+ # The process completed, but the report summary's status is unknown. This
519
+ # state isn't used for new reports.
430
520
  SUMMARY_UNKNOWN = 4
431
521
  end
432
522
  end
433
523
 
434
- # The regulatory family of the control.
524
+ # Regulatory family of the control.
435
525
  # @!attribute [rw] family_id
436
526
  # @return [::String]
437
- # The ID of the regulatory control family.
527
+ # ID of the regulatory control family. To find the list of supported
528
+ # control families, use the
529
+ # {::Google::Cloud::AuditManager::V1::AuditManager::Client#list_controls ListControls}
530
+ # method and review the `control_family` field in the response.
438
531
  # @!attribute [rw] display_name
439
532
  # @return [::String]
440
- # The display name of the regulatory control family.
533
+ # Display name of the regulatory control family.
441
534
  class ControlFamily
442
535
  include ::Google::Protobuf::MessageExts
443
536
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -446,118 +539,118 @@ module Google
446
539
  # A control.
447
540
  # @!attribute [r] id
448
541
  # @return [::String]
449
- # Output only. The control identifier used to fetch the findings. This is
450
- # same as the control report name.
542
+ # Output only. Control identifier that's used to fetch the findings. The
543
+ # identifier is the same as the control report name.
451
544
  # @!attribute [r] display_name
452
545
  # @return [::String]
453
546
  # Output only. Display name of the control.
454
547
  # @!attribute [r] family
455
548
  # @return [::Google::Cloud::AuditManager::V1::Control::Family]
456
- # Output only. Group where the control belongs. E.g. Access Control.
549
+ # Output only. Category that the control belongs to.
457
550
  # @!attribute [r] control_family
458
551
  # @return [::Google::Cloud::AuditManager::V1::ControlFamily]
459
- # Output only. Regulatory Family of the control E.g. Access Control
552
+ # Output only. Regulatory family of the control.
460
553
  # @!attribute [r] description
461
554
  # @return [::String]
462
- # Output only. Regulatory control ask of the control
555
+ # Output only. Description of the control.
463
556
  # @!attribute [r] responsibility_type
464
557
  # @return [::String]
465
- # Output only. The type of responsibility for implementing this control. It
466
- # can be google, customer or shared.
558
+ # Output only. Who is responsible for implementing this control. Set to one
559
+ # of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
467
560
  # @!attribute [r] google_responsibility_description
468
561
  # @return [::String]
469
- # Output only. Description of the google responsibility for implementing this
470
- # control.
562
+ # Output only. A description of Google's responsibility for this control.
471
563
  # @!attribute [r] google_responsibility_implementation
472
564
  # @return [::String]
473
- # Output only. Implementation of the google responsibility for implementing
565
+ # Output only. A description of how Google implements its responsibility for
474
566
  # this control.
475
567
  # @!attribute [r] customer_responsibility_description
476
568
  # @return [::String]
477
- # Output only. Description of the customer responsibility for implementing
478
- # this control.
569
+ # Output only. A description of your responsibility for this control.
479
570
  # @!attribute [r] customer_responsibility_implementation
480
571
  # @return [::String]
481
- # Output only. Implementation of the customer responsibility for implementing
572
+ # Output only. A description of how you can implement your responsibility for
482
573
  # this control.
483
574
  class Control
484
575
  include ::Google::Protobuf::MessageExts
485
576
  extend ::Google::Protobuf::MessageExts::ClassMethods
486
577
 
487
- # The family of the control. For example, Access Control.
578
+ # Category of the control.
488
579
  module Family
489
- # Unspecified. Invalid state.
580
+ # Default value. This value is unused.
490
581
  FAMILY_UNSPECIFIED = 0
491
582
 
492
- # Access Control
583
+ # Access control.
493
584
  AC = 1
494
585
 
495
- # Awareness and Training
586
+ # Awareness and training.
496
587
  AT = 2
497
588
 
498
- # Audit and Accountability
589
+ # Audit and accountability.
499
590
  AU = 3
500
591
 
501
- # Certification, Accreditation and Security Assessments
592
+ # Certification, accreditation and security assessments.
502
593
  CA = 4
503
594
 
504
- # Configuration Management
595
+ # Configuration management and change control.
505
596
  CM = 5
506
597
 
507
- # Contingency Planning
598
+ # Contingency planning and disaster recovery.
508
599
  CP = 6
509
600
 
510
- # Identification and Authentication
601
+ # Identification and authentication.
511
602
  IA = 7
512
603
 
513
- # Incident Response
604
+ # Incident response.
514
605
  IR = 8
515
606
 
516
- # Maintenance
607
+ # Maintenance.
517
608
  MA = 9
518
609
 
519
- # Media Protection
610
+ # Media protection.
520
611
  MP = 10
521
612
 
522
- # Physical and Environmental Protection
613
+ # Physical and environmental protection.
523
614
  PE = 11
524
615
 
525
- # Security Planning
616
+ # Security planning.
526
617
  PL = 12
527
618
 
528
- # Personnel Security
619
+ # Personnel security.
529
620
  PS = 13
530
621
 
531
- # Risk Assessment
622
+ # Risk assessment.
532
623
  RA = 14
533
624
 
534
- # System Services and Acquisition
625
+ # System services and acquisition.
535
626
  SA = 15
536
627
 
537
- # System and Communications Protection
628
+ # System and communications protection.
538
629
  SC = 16
539
630
 
540
- # System and Information Integrity
631
+ # System and information integrity.
541
632
  SI = 17
542
633
 
543
- # Supply Chain Risk Management
634
+ # Supply chain risk management.
544
635
  SR = 18
545
636
  end
546
637
  end
547
638
 
548
- # The locations where the generated reports are saved.
639
+ # Cloud Storage bucket where the audit report is uploaded to.
549
640
  # @!attribute [rw] gcs_bucket_uri
550
641
  # @return [::String]
551
- # The Cloud Storage bucket where the audit report is/will be uploaded.
642
+ # URI for the Cloud Storage bucket, in the format
643
+ # `gs://{bucket_name}`.
552
644
  class DestinationDetails
553
645
  include ::Google::Protobuf::MessageExts
554
646
  extend ::Google::Protobuf::MessageExts::ClassMethods
555
647
  end
556
648
 
557
- # The additional information for an audit operation.
649
+ # Additional information about the number of checks that were made during an
650
+ # audit operation.
558
651
  # @!attribute [rw] total_count
559
652
  # @return [::Integer]
560
- # Total number of checks.
653
+ # Total number of evaluated checks.
561
654
  # @!attribute [rw] compliant_count
562
655
  # @return [::Integer]
563
656
  # Number of compliant checks.
@@ -566,80 +659,80 @@ module Google
566
659
  # Number of checks with violations.
567
660
  # @!attribute [rw] manual_review_needed_count
568
661
  # @return [::Integer]
569
- # Number of checks with "manual review needed" status.
662
+ # Number of checks that require a manual review.
570
663
  # @!attribute [rw] error_count
571
664
  # @return [::Integer]
572
- # Number of checks that could not be performed due to errors.
665
+ # Number of checks that can't be performed due to errors.
573
666
  class ReportSummary
574
667
  include ::Google::Protobuf::MessageExts
575
668
  extend ::Google::Protobuf::MessageExts::ClassMethods
576
669
  end
577
670
 
578
- # The evaluation details for a control.
671
+ # Evaluation details for a control.
579
672
  # @!attribute [rw] control
580
673
  # @return [::Google::Cloud::AuditManager::V1::Control]
581
- # The control for which the findings are being reported.
674
+ # Control that the findings are being reported for.
582
675
  # @!attribute [r] compliance_state
583
676
  # @return [::Google::Cloud::AuditManager::V1::ComplianceState]
584
677
  # Output only. Overall status of the findings for the control.
585
678
  # @!attribute [rw] control_report_summary
586
679
  # @return [::Google::Cloud::AuditManager::V1::ReportSummary]
587
- # Report summary with compliance, violation counts etc.
680
+ # A control report summary that provides a high-level overview of the
681
+ # compliance controls and the assessment status.
588
682
  class ControlDetails
589
683
  include ::Google::Protobuf::MessageExts
590
684
  extend ::Google::Protobuf::MessageExts::ClassMethods
591
685
  end
592
686
 
593
- # The different execution states of the Audit Manager service.
687
+ # Different execution states of the Audit Manager service.
594
688
  module OperationState
595
- # Unspecified. Invalid state.
689
+ # Default value. This value is unused.
596
690
  OPERATION_STATE_UNSPECIFIED = 0
597
691
 
598
- # Audit report generation process has not started.
692
+ # Audit generation process hasn't started.
599
693
  OPERATION_STATE_NOT_STARTED = 10
600
694
 
601
- # Audit Manager is currently evaluating the workloads against specific
602
- # standard.
695
+ # Evaluation process is in progress.
603
696
  OPERATION_STATE_EVALUATION_IN_PROGRESS = 20
604
697
 
605
- # Audit Manager has completed Evaluation for the workload.
698
+ # Evaluation process is completed.
606
699
  OPERATION_STATE_EVALUATION_DONE = 21
607
700
 
608
- # Audit Manager is creating audit report from the evaluated data.
701
+ # Report generation process is in progress.
609
702
  OPERATION_STATE_EVIDENCE_REPORT_GENERATION_IN_PROGRESS = 30
610
703
 
611
- # Audit Manager has completed generation of the audit report.
704
+ # Report generation process is completed.
612
705
  OPERATION_STATE_EVIDENCE_REPORT_GENERATION_DONE = 31
613
706
 
614
- # Audit Manager is uploading the audit report and evidences to the customer
615
- # provided destination.
707
+ # The audit report and evidence are being uploaded to your bucket.
616
708
  OPERATION_STATE_EVIDENCE_UPLOAD_IN_PROGRESS = 40
617
709
 
618
- # Audit report generation process is completed.
710
+ # The audit report and evidence are uploaded to your bucket.
619
711
  OPERATION_STATE_DONE = 50
620
712
 
621
- # Audit report generation process has failed.
713
+ # Audit report generation process failed.
622
714
  OPERATION_STATE_FAILED = 60
623
715
  end
624
716
 
625
- # The compliance state after evaluation.
717
+ # Compliance state after evaluation.
626
718
  module ComplianceState
627
- # Unspecified. Invalid state.
719
+ # Default value. This value is unused.
628
720
  COMPLIANCE_STATE_UNSPECIFIED = 0
629
721
 
630
- # Compliant.
722
+ # The resource is compliant.
631
723
  COMPLIANT = 1
632
724
 
633
- # Violation.
725
+ # The resource isn't compliant.
634
726
  VIOLATION = 2
635
727
 
636
- # MANUAL_REVIEW_NEEDED, requires manual review
728
+ # You must complete a manual review.
637
729
  MANUAL_REVIEW_NEEDED = 3
638
730
 
639
- # Error while computing status.
731
+ # An error was encountered during the evaluation or evidence gathering
732
+ # process.
640
733
  ERROR = 4
641
734
 
642
- # Cannot be audited
735
+ # The resource can't be audited.
643
736
  AUDIT_NOT_SUPPORTED = 5
644
737
  end
645
738
  end