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