@maxim_mazurok/gapi.client.assuredworkloads-v1 0.3.20261015 → 0.3.20261102

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 (2) hide show
  1. package/index.d.ts +152 -152
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://assuredworkloads.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20261015
12
+ // Revision: 20261102
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -29,16 +29,16 @@ declare namespace gapi.client {
29
29
 
30
30
  namespace assuredworkloads {
31
31
  interface GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest {
32
- /** Optional. Acknowledge type of specified violation. */
32
+ /** Optional. The scope of the acknowledgement for the specified violation. If not specified, `SINGLE_VIOLATION` is used. */
33
33
  acknowledgeType?:
34
34
  | 'ACKNOWLEDGE_TYPE_UNSPECIFIED'
35
35
  | 'SINGLE_VIOLATION'
36
36
  | 'EXISTING_CHILD_RESOURCE_VIOLATIONS';
37
- /** Required. Business justification explaining the need for violation acknowledgement */
37
+ /** Required. The business justification for acknowledging the violation. The comment can't be empty or contain only whitespace characters. */
38
38
  comment?: string;
39
- /** Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name} */
39
+ /** Optional. Deprecated: This field is deprecated and will be removed in a future version of the API. The service identifies the violation to acknowledge by `name`, and ignores this field. Don't set this field. The name of the organization policy that was modified with a non-compliant change and resulted in this violation. Formats: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` */
40
40
  nonCompliantOrgPolicy?: string;
41
- /** Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for acknowledging violations. */
41
+ /** Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) that the violation belongs to. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used. */
42
42
  view?:
43
43
  | 'VIOLATION_VIEW_UNSPECIFIED'
44
44
  | 'VIOLATION_VIEW_ASSURED_WORKLOADS'
@@ -46,13 +46,13 @@ declare namespace gapi.client {
46
46
  }
47
47
  interface GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse {}
48
48
  interface GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse {
49
- /** The list of aggregated compliance reports. */
49
+ /** The daily compliance reports for the requested time range. */
50
50
  aggregatedComplianceReports?: GoogleCloudAssuredworkloadsV1AggregatedComplianceReport[];
51
51
  }
52
52
  interface GoogleCloudAssuredworkloadsV1AggregatedComplianceReport {
53
- /** The control assessment details of the framework. */
53
+ /** The number of passing, failing, and not assessed controls in the framework at `report_time`. */
54
54
  controlAssessmentDetails?: GoogleCloudAssuredworkloadsV1ControlAssessmentDetails;
55
- /** The report time of the aggregated compliance report. */
55
+ /** The time that the compliance report represents. */
56
56
  reportTime?: string;
57
57
  }
58
58
  interface GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse {
@@ -234,7 +234,7 @@ declare namespace gapi.client {
234
234
  displayName?: string;
235
235
  /** Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group. */
236
236
  isFakeControl?: boolean;
237
- /** Identifier. The name of the control compliance summary. */
237
+ /** Identifier. The resource name of the control compliance summary. Format: `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}/dbControlComplianceSummaries/{db_control_compliance_summary}` */
238
238
  name?: string;
239
239
  /** Output only. Number of organization policy findings for this control. */
240
240
  orgPolicyFindingCount?: string;
@@ -252,9 +252,9 @@ declare namespace gapi.client {
252
252
  totalFindingsCount?: number;
253
253
  }
254
254
  interface GoogleCloudAssuredworkloadsV1DbFindingSummary {
255
- /** Output only. The category of the finding. */
255
+ /** Output only. The category of the findings that are summarized. */
256
256
  findingCategory?: string;
257
- /** Output only. The class of the finding. */
257
+ /** Output only. The class of the findings. */
258
258
  findingClass?:
259
259
  | 'FINDING_CLASS_UNSPECIFIED'
260
260
  | 'THREAT'
@@ -266,32 +266,32 @@ declare namespace gapi.client {
266
266
  | 'TOXIC_COMBINATION'
267
267
  | 'SENSITIVE_DATA_RISK'
268
268
  | 'CHOKEPOINT';
269
- /** Output only. The count of the finding. */
269
+ /** Output only. The total number of active findings in the category. */
270
270
  findingCount?: string;
271
- /** Identifier. The name of the finding summary. */
271
+ /** Identifier. The resource name of the finding summary. */
272
272
  name?: string;
273
- /** Output only. Number of active organization policy findings for this category. */
273
+ /** Output only. The number of active organization policy findings in the category. */
274
274
  organizationPolicyFindingCount?: string;
275
- /** Optional. The list of compliance frameworks that the finding belongs to. */
275
+ /** Optional. The display names of the compliance frameworks that the findings are related to. */
276
276
  relatedFrameworks?: string[];
277
- /** Output only. Number of active resource findings for this category. */
277
+ /** Output only. The number of active resource findings in the category. */
278
278
  resourceFindingCount?: string;
279
- /** Output only. The severity of the finding. */
279
+ /** Output only. The severity of the findings. */
280
280
  severity?:
281
281
  'SEVERITY_UNSPECIFIED' | 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW';
282
- /** Output only. The last updated time of the finding. */
282
+ /** Output only. The time when the findings in the category were last updated. */
283
283
  updateTime?: string;
284
284
  }
285
285
  interface GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary {
286
- /** The control assessment details of the framework. */
286
+ /** The number of passing, failing, and not assessed controls in the framework. */
287
287
  controlAssessmentDetails?: GoogleCloudAssuredworkloadsV1ControlAssessmentDetails;
288
- /** Output only. The trend of controls that are passing for the given duration. */
288
+ /** Output only. The trend of passing controls over the trend duration. This field is only populated when using `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL`. */
289
289
  controlsPassingTrend?: GoogleCloudAssuredworkloadsV1Trend;
290
- /** Output only. The count of the findings generated against the framework. */
290
+ /** Output only. The number of findings that were generated against the framework. This field is only populated when using `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL`. */
291
291
  findingCount?: string;
292
- /** The name of the framework. */
292
+ /** The resource name of the compliance framework. */
293
293
  framework?: string;
294
- /** The list of framework categories supported by the framework. */
294
+ /** The categories of the framework. */
295
295
  frameworkCategories?:
296
296
  | 'FRAMEWORK_CATEGORY_UNSPECIFIED'
297
297
  | 'INDUSTRY_DEFINED_STANDARD'
@@ -299,30 +299,30 @@ declare namespace gapi.client {
299
299
  | 'DATA_SECURITY'
300
300
  | 'GOOGLE_BEST_PRACTICES'
301
301
  | 'CUSTOM_FRAMEWORK'[];
302
- /** Optional. The display name for the framework. */
302
+ /** Optional. The display name of the framework. */
303
303
  frameworkDisplayName?: string;
304
- /** The type of framework. */
304
+ /** The type of the framework. */
305
305
  frameworkType?: 'FRAMEWORK_TYPE_UNSPECIFIED' | 'BUILT_IN' | 'CUSTOM';
306
306
  /** The major revision ID of the framework. */
307
307
  majorRevisionId?: string;
308
308
  /** The minor revision ID of the framework. */
309
309
  minorRevisionId?: string;
310
- /** Identifier. The name of the framework compliance summary. */
310
+ /** Identifier. The resource name of the framework compliance summary. */
311
311
  name?: string;
312
- /** The list of cloud providers supported by the framework. */
312
+ /** The cloud providers that are supported by the framework. */
313
313
  supportedCloudProviders?:
314
314
  'CLOUD_PROVIDER_UNSPECIFIED' | 'AWS' | 'AZURE' | 'GCP'[];
315
- /** The target resource details for the framework. */
315
+ /** The details of the target resources (organizations, folders, or projects) that the framework is deployed on. */
316
316
  targetResourceDetails?: GoogleCloudAssuredworkloadsV1TargetResourceDetails[];
317
317
  }
318
318
  interface GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse {}
319
319
  interface GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse {}
320
320
  interface GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse {
321
- /** The control assessment details of the framework. */
321
+ /** The number of passing, failing, and not assessed controls in the framework. */
322
322
  controlAssessmentDetails?: GoogleCloudAssuredworkloadsV1ControlAssessmentDetails;
323
- /** The name of the framework. */
323
+ /** The resource name of the compliance framework. For example, `organizations/{organization}/locations/{location}/frameworks/{framework_id}`. */
324
324
  framework?: string;
325
- /** The list of framework categories supported. */
325
+ /** The categories of the framework. */
326
326
  frameworkCategories?:
327
327
  | 'FRAMEWORK_CATEGORY_UNSPECIFIED'
328
328
  | 'INDUSTRY_DEFINED_STANDARD'
@@ -332,7 +332,7 @@ declare namespace gapi.client {
332
332
  | 'CUSTOM_FRAMEWORK'[];
333
333
  /** The description of the framework. */
334
334
  frameworkDescription?: string;
335
- /** Optional. The display name for the framework. */
335
+ /** Optional. The display name of the framework. */
336
336
  frameworkDisplayName?: string;
337
337
  /** The type of the framework. */
338
338
  frameworkType?: 'FRAMEWORK_TYPE_UNSPECIFIED' | 'BUILT_IN' | 'CUSTOM';
@@ -340,40 +340,40 @@ declare namespace gapi.client {
340
340
  majorRevisionId?: string;
341
341
  /** The latest minor revision ID of the latest major revision of the framework. */
342
342
  minorRevisionId?: string;
343
- /** The name of the framework compliance report. */
343
+ /** The resource name of the framework compliance report. */
344
344
  name?: string;
345
- /** The list of cloud providers that are supported by the framework. */
345
+ /** The cloud providers that are supported by the framework. */
346
346
  supportedCloudProviders?:
347
347
  'CLOUD_PROVIDER_UNSPECIFIED' | 'AWS' | 'AZURE' | 'GCP'[];
348
- /** The target resource details of the framework. */
348
+ /** The details of the target resources (organizations, folders, or projects) that the framework is deployed on. */
349
349
  targetResourceDetails?: GoogleCloudAssuredworkloadsV1TargetResourceDetails[];
350
- /** Output only. The last updated time of the report. */
350
+ /** Output only. The time when the report was last updated. */
351
351
  updateTime?: string;
352
352
  }
353
353
  interface GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse {
354
- /** The list of control compliance details. */
354
+ /** The list of control compliance summaries. */
355
355
  dbControlComplianceSummaries?: GoogleCloudAssuredworkloadsV1DbControlComplianceSummary[];
356
- /** Output only. The token to retrieve the next page of results. */
356
+ /** Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. */
357
357
  nextPageToken?: string;
358
358
  }
359
359
  interface GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse {
360
- /** List of finding summary by category. */
360
+ /** The list of finding summaries, one for each finding category. */
361
361
  dbFindingSummaries?: GoogleCloudAssuredworkloadsV1DbFindingSummary[];
362
- /** Output only. The token to retrieve the next page of results. */
362
+ /** Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. */
363
363
  nextPageToken?: string;
364
364
  }
365
365
  interface GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse {
366
366
  /** The list of framework compliance summaries. */
367
367
  dbFrameworkComplianceSummaries?: GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary[];
368
- /** Output only. The token to retrieve the next page of results. */
368
+ /** Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. */
369
369
  nextPageToken?: string;
370
370
  }
371
371
  interface GoogleCloudAssuredworkloadsV1ListViolationsResponse {
372
- /** The next page token. Returns empty if reached the last page. */
372
+ /** A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. */
373
373
  nextPageToken?: string;
374
- /** The total number of violations. */
374
+ /** The total number of violations that match the request, across all pages. This field might not be populated for all requests; when it's not populated, its value is `0`. */
375
375
  totalSize?: number;
376
- /** List of Violations under a Workload. */
376
+ /** The list of violations. */
377
377
  violations?: GoogleCloudAssuredworkloadsV1Violation[];
378
378
  }
379
379
  interface GoogleCloudAssuredworkloadsV1ListWorkloadsResponse {
@@ -510,67 +510,67 @@ declare namespace gapi.client {
510
510
  orgPolicyUpdate?: GoogleCloudAssuredworkloadsV1OrgPolicyUpdate;
511
511
  }
512
512
  interface GoogleCloudAssuredworkloadsV1Violation {
513
- /** A boolean that indicates if the violation is acknowledged */
513
+ /** Whether the violation has been acknowledged. */
514
514
  acknowledged?: boolean;
515
- /** Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. */
515
+ /** Optional. The time when the violation was first acknowledged. To find the most recent time that the violation was acknowledged, check `exception_contexts`. This field is absent when `acknowledged` is `false`. */
516
516
  acknowledgementTime?: string;
517
- /** Output only. List of compliance frameworks that are affected by this violation. This field is only populated when using `VIOLATION_VIEW_DATA_BOUNDARY`. e.g. "FedRAMP High", "NIST 800-53". */
517
+ /** Output only. The IDs of the compliance frameworks that are affected by this violation. For example, `builtin-fedramp-high`. This field is only populated when using `VIOLATION_VIEW_DATA_BOUNDARY`. */
518
518
  affectedFrameworks?: string[];
519
- /** Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations. */
519
+ /** Optional. Output only. For resource violations, the ID of the organization policy violation that caused this resource violation. This field is empty for organization policy violations. */
520
520
  associatedOrgPolicyViolationId?: string;
521
- /** Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} */
521
+ /** Output only. Immutable. A link to the Cloud Audit Logs entries for the violated resource. Format: `https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}` */
522
522
  auditLogLink?: string;
523
- /** Output only. Time of the event which triggered the Violation. */
523
+ /** Output only. The time of the event that triggered the violation. */
524
524
  beginTime?: string;
525
- /** Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. */
525
+ /** Output only. The category that the violation is mapped to. For example, `Location`, `Service Usage`, `Access`, or `Encryption`. */
526
526
  category?: string;
527
- /** Optional. Output only. The number of resource violations for particular org policy violation. This will be 0 in case of resource violation. */
527
+ /** Optional. Output only. For organization policy violations, the number of resource violations that are associated with this violation. This field is `0` for resource violations. */
528
528
  childResourceViolationCount?: number;
529
- /** Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value. */
529
+ /** Output only. A description of the violation. For example, `OrgPolicy gcp.resourceLocations has non compliant value.` */
530
530
  description?: string;
531
- /** Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} */
531
+ /** Output only. Immutable. A link to the Cloud Audit Logs entries that contain the business justification that was provided when the violation was acknowledged. Format: `https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization}` */
532
532
  exceptionAuditLogLink?: string;
533
- /** Output only. List of all the exception detail added for the violation. */
533
+ /** Output only. The details of all of the acknowledgements (exceptions) for the violation. */
534
534
  exceptionContexts?: GoogleCloudAssuredworkloadsV1ViolationExceptionContext[];
535
- /** Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} */
535
+ /** Output only. Immutable. The resource name of the violation. Format: `organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}` */
536
536
  name?: string;
537
- /** Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name} */
537
+ /** Output only. Immutable. The name of the organization policy that was modified with a non-compliant change and resulted in this violation. Formats: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` */
538
538
  nonCompliantOrgPolicy?: string;
539
- /** Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation. */
539
+ /** Output only. Immutable. Deprecated: This field is deprecated and might be removed in a future version of the API. Use `non_compliant_org_policy` instead, which contains the full resource name of the organization policy, including the constraint name. The organization policy constraint that was changed in a non-compliant way, which resulted in this violation. */
540
540
  orgPolicyConstraint?: string;
541
- /** Optional. Output only. Parent project number where resource is present. Empty for org-policy violations. */
541
+ /** Optional. Output only. For resource violations, the number of the project that contains the non-compliant resource. This field is empty for organization policy violations. */
542
542
  parentProjectNumber?: string;
543
- /** Output only. Compliance violation remediation */
543
+ /** Output only. The remediation guidance for the violation. */
544
544
  remediation?: GoogleCloudAssuredworkloadsV1ViolationRemediation;
545
- /** Output only. Contains the remediation instructions for the violation in markdown format. */
545
+ /** Output only. The remediation instructions for the violation, in Markdown format. This field is only populated by `GetViolation` when using `VIOLATION_VIEW_DATA_BOUNDARY`. When this field isn't populated, see `remediation` instead. */
546
546
  remediationMarkdown?: string;
547
- /** Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. */
547
+ /** Output only. The time of the event that resolved the violation. This field is empty if the violation is unresolved. */
548
548
  resolveTime?: string;
549
- /** Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations. */
549
+ /** Optional. Output only. For resource violations, the full resource name of the non-compliant resource. For example, `//storage.googleapis.com/myprojectxyz-testbucket`. This field is empty for organization policy violations. */
550
550
  resourceName?: string;
551
- /** Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations. */
551
+ /** Optional. Output only. For resource violations, the type of the non-compliant resource. For example, `compute.googleapis.com/Disk`. This field is empty for organization policy violations. */
552
552
  resourceType?: string;
553
- /** Output only. State of the violation */
553
+ /** Output only. The state of the violation. */
554
554
  state?: 'STATE_UNSPECIFIED' | 'RESOLVED' | 'UNRESOLVED' | 'EXCEPTION';
555
- /** Output only. The last time when the Violation record was updated. */
555
+ /** Output only. The time when the violation record was last updated. */
556
556
  updateTime?: string;
557
- /** Output only. Type of the violation */
557
+ /** Output only. The type of the violation. */
558
558
  violationType?: 'VIOLATION_TYPE_UNSPECIFIED' | 'ORG_POLICY' | 'RESOURCE';
559
559
  }
560
560
  interface GoogleCloudAssuredworkloadsV1ViolationExceptionContext {
561
- /** Timestamp when the violation was acknowledged. */
561
+ /** The time when the violation was acknowledged. */
562
562
  acknowledgementTime?: string;
563
- /** Business justification provided towards the acknowledgement of the violation. */
563
+ /** The business justification that was provided when the violation was acknowledged. */
564
564
  comment?: string;
565
- /** Name of the user (or service account) who acknowledged the violation. */
565
+ /** The name of the user (or service account) who acknowledged the violation. */
566
566
  userName?: string;
567
567
  }
568
568
  interface GoogleCloudAssuredworkloadsV1ViolationRemediation {
569
- /** Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values */
569
+ /** The values that can resolve the violation. For example, for list organization policy violations, this field contains the list of allowed or denied values. */
570
570
  compliantValues?: string[];
571
- /** Required. Remediation instructions to resolve violations */
571
+ /** Required. The instructions to resolve the violation. */
572
572
  instructions?: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions;
573
- /** Output only. Reemediation type based on the type of org policy values violated */
573
+ /** Output only. The remediation type, which is based on the type of organization policy values that were violated. */
574
574
  remediationType?:
575
575
  | 'REMEDIATION_TYPE_UNSPECIFIED'
576
576
  | 'REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION'
@@ -581,25 +581,25 @@ declare namespace gapi.client {
581
581
  | 'REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES';
582
582
  }
583
583
  interface GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions {
584
- /** Remediation instructions to resolve violation via cloud console */
584
+ /** Instructions to resolve the violation by using the Google Cloud console. */
585
585
  consoleInstructions?: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole;
586
- /** Remediation instructions to resolve violation via gcloud cli */
586
+ /** Instructions to resolve the violation by using the gcloud CLI. */
587
587
  gcloudInstructions?: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud;
588
588
  }
589
589
  interface GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole {
590
- /** Additional urls for more information about steps */
590
+ /** Additional URLs with more information about the steps. */
591
591
  additionalLinks?: string[];
592
- /** Link to console page where violations can be resolved */
592
+ /** Links to the Google Cloud console pages where the violation can be resolved. */
593
593
  consoleUris?: string[];
594
- /** Steps to resolve violation via cloud console */
594
+ /** The steps to resolve the violation by using the Google Cloud console. */
595
595
  steps?: string[];
596
596
  }
597
597
  interface GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud {
598
- /** Additional urls for more information about steps */
598
+ /** Additional URLs with more information about the steps. */
599
599
  additionalLinks?: string[];
600
- /** Gcloud command to resolve violation */
600
+ /** The gcloud CLI commands that resolve the violation. */
601
601
  gcloudCommands?: string[];
602
- /** Steps to resolve violation via gcloud cli */
602
+ /** The steps to resolve the violation by using the gcloud CLI. */
603
603
  steps?: string[];
604
604
  }
605
605
  interface GoogleCloudAssuredworkloadsV1Workload {
@@ -838,7 +838,7 @@ declare namespace gapi.client {
838
838
  message?: string;
839
839
  }
840
840
  interface DbFindingSummariesResource {
841
- /** Lists the finding summary by category for a given scope. */
841
+ /** Lists summaries of the active findings in a Data Boundary scope (an organization, folder, or project), with one summary for each finding category. */
842
842
  list(request?: {
843
843
  /** V1 error format. */
844
844
  '$.xgafv'?: '1' | '2';
@@ -850,7 +850,7 @@ declare namespace gapi.client {
850
850
  callback?: string;
851
851
  /** Selector specifying which fields to include in a partial response. */
852
852
  fields?: string;
853
- /** Optional. The filtering results. */
853
+ /** Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework). */
854
854
  filter?: string;
855
855
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
856
856
  key?: string;
@@ -858,9 +858,9 @@ declare namespace gapi.client {
858
858
  oauth_token?: string;
859
859
  /** Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. */
860
860
  pageSize?: number;
861
- /** Optional. A token that identifies the page of results that the server should return. */
861
+ /** Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result. */
862
862
  pageToken?: string;
863
- /** Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location} */
863
+ /** Required. The parent scope to list finding summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}` */
864
864
  parent: string;
865
865
  /** Returns response with indentations and line breaks. */
866
866
  prettyPrint?: boolean;
@@ -873,7 +873,7 @@ declare namespace gapi.client {
873
873
  }): Request<GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse>;
874
874
  }
875
875
  interface DbControlComplianceSummariesResource {
876
- /** Lists the control compliance summary for a given scope. */
876
+ /** Lists the compliance summaries of the controls in a framework compliance report. */
877
877
  list(request?: {
878
878
  /** V1 error format. */
879
879
  '$.xgafv'?: '1' | '2';
@@ -885,7 +885,7 @@ declare namespace gapi.client {
885
885
  callback?: string;
886
886
  /** Selector specifying which fields to include in a partial response. */
887
887
  fields?: string;
888
- /** Optional. The filtering results. */
888
+ /** Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = "2026-01-01T00:00:00Z"`. Only findings that were updated at or after this time are counted. */
889
889
  filter?: string;
890
890
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
891
891
  key?: string;
@@ -893,9 +893,9 @@ declare namespace gapi.client {
893
893
  oauth_token?: string;
894
894
  /** Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000. */
895
895
  pageSize?: number;
896
- /** Optional. A token that identifies the page of results that the server should return. */
896
+ /** Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result. */
897
897
  pageToken?: string;
898
- /** Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} */
898
+ /** Required. The framework compliance report to list control compliance summaries for. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
899
899
  parent: string;
900
900
  /** Returns response with indentations and line breaks. */
901
901
  prettyPrint?: boolean;
@@ -908,7 +908,7 @@ declare namespace gapi.client {
908
908
  }): Request<GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse>;
909
909
  }
910
910
  interface DbFrameworkComplianceReportsResource {
911
- /** Gets the aggregated compliance report over time for a given scope. */
911
+ /** Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope. */
912
912
  aggregate(request?: {
913
913
  /** V1 error format. */
914
914
  '$.xgafv'?: '1' | '2';
@@ -920,7 +920,7 @@ declare namespace gapi.client {
920
920
  callback?: string;
921
921
  /** Selector specifying which fields to include in a partial response. */
922
922
  fields?: string;
923
- /** Optional. The filtering results. */
923
+ /** Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework). */
924
924
  filter?: string;
925
925
  /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
926
926
  'interval.endTime'?: string;
@@ -928,7 +928,7 @@ declare namespace gapi.client {
928
928
  'interval.startTime'?: string;
929
929
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
930
930
  key?: string;
931
- /** Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
931
+ /** Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
932
932
  name: string;
933
933
  /** OAuth 2.0 token for the current user. */
934
934
  oauth_token?: string;
@@ -941,7 +941,7 @@ declare namespace gapi.client {
941
941
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
942
942
  uploadType?: string;
943
943
  }): Request<GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse>;
944
- /** Fetches the framework compliance report for a given scope. */
944
+ /** Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework. */
945
945
  fetch(request?: {
946
946
  /** V1 error format. */
947
947
  '$.xgafv'?: '1' | '2';
@@ -951,15 +951,15 @@ declare namespace gapi.client {
951
951
  alt?: 'json' | 'media' | 'proto';
952
952
  /** JSONP */
953
953
  callback?: string;
954
- /** Optional. The end time of the report. */
954
+ /** Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state. */
955
955
  endTime?: string;
956
956
  /** Selector specifying which fields to include in a partial response. */
957
957
  fields?: string;
958
- /** Optional. The filtering results. */
958
+ /** Optional. A filter expression that restricts the results. Reserved for future use. */
959
959
  filter?: string;
960
960
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
961
961
  key?: string;
962
- /** Required. The name of the framework compliance report to retrieve. */
962
+ /** Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
963
963
  name: string;
964
964
  /** OAuth 2.0 token for the current user. */
965
965
  oauth_token?: string;
@@ -975,7 +975,7 @@ declare namespace gapi.client {
975
975
  dbControlComplianceSummaries: DbControlComplianceSummariesResource;
976
976
  }
977
977
  interface DbFrameworkComplianceSummariesResource {
978
- /** Lists the framework compliance summary for a given scope. */
978
+ /** Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project). */
979
979
  list(request?: {
980
980
  /** V1 error format. */
981
981
  '$.xgafv'?: '1' | '2';
@@ -987,7 +987,7 @@ declare namespace gapi.client {
987
987
  callback?: string;
988
988
  /** Selector specifying which fields to include in a partial response. */
989
989
  fields?: string;
990
- /** Optional. The filtering results. */
990
+ /** Optional. A filter expression that restricts the results. Reserved for future use. */
991
991
  filter?: string;
992
992
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
993
993
  key?: string;
@@ -995,9 +995,9 @@ declare namespace gapi.client {
995
995
  oauth_token?: string;
996
996
  /** Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000. */
997
997
  pageSize?: number;
998
- /** Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result. */
998
+ /** Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result. */
999
999
  pageToken?: string;
1000
- /** Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} */
1000
+ /** Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}` */
1001
1001
  parent: string;
1002
1002
  /** Returns response with indentations and line breaks. */
1003
1003
  prettyPrint?: boolean;
@@ -1007,7 +1007,7 @@ declare namespace gapi.client {
1007
1007
  upload_protocol?: string;
1008
1008
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1009
1009
  uploadType?: string;
1010
- /** Optional. Specifies the level of detail to return in the response. */
1010
+ /** Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used. */
1011
1011
  view?:
1012
1012
  | 'FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED'
1013
1013
  | 'FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC'
@@ -1023,7 +1023,7 @@ declare namespace gapi.client {
1023
1023
  locations: LocationsResource;
1024
1024
  }
1025
1025
  interface DbFindingSummariesResource {
1026
- /** Lists the finding summary by category for a given scope. */
1026
+ /** Lists summaries of the active findings in a Data Boundary scope (an organization, folder, or project), with one summary for each finding category. */
1027
1027
  list(request?: {
1028
1028
  /** V1 error format. */
1029
1029
  '$.xgafv'?: '1' | '2';
@@ -1035,7 +1035,7 @@ declare namespace gapi.client {
1035
1035
  callback?: string;
1036
1036
  /** Selector specifying which fields to include in a partial response. */
1037
1037
  fields?: string;
1038
- /** Optional. The filtering results. */
1038
+ /** Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework). */
1039
1039
  filter?: string;
1040
1040
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1041
1041
  key?: string;
@@ -1043,9 +1043,9 @@ declare namespace gapi.client {
1043
1043
  oauth_token?: string;
1044
1044
  /** Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. */
1045
1045
  pageSize?: number;
1046
- /** Optional. A token that identifies the page of results that the server should return. */
1046
+ /** Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result. */
1047
1047
  pageToken?: string;
1048
- /** Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location} */
1048
+ /** Required. The parent scope to list finding summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}` */
1049
1049
  parent: string;
1050
1050
  /** Returns response with indentations and line breaks. */
1051
1051
  prettyPrint?: boolean;
@@ -1058,7 +1058,7 @@ declare namespace gapi.client {
1058
1058
  }): Request<GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse>;
1059
1059
  }
1060
1060
  interface DbControlComplianceSummariesResource {
1061
- /** Lists the control compliance summary for a given scope. */
1061
+ /** Lists the compliance summaries of the controls in a framework compliance report. */
1062
1062
  list(request?: {
1063
1063
  /** V1 error format. */
1064
1064
  '$.xgafv'?: '1' | '2';
@@ -1070,7 +1070,7 @@ declare namespace gapi.client {
1070
1070
  callback?: string;
1071
1071
  /** Selector specifying which fields to include in a partial response. */
1072
1072
  fields?: string;
1073
- /** Optional. The filtering results. */
1073
+ /** Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = "2026-01-01T00:00:00Z"`. Only findings that were updated at or after this time are counted. */
1074
1074
  filter?: string;
1075
1075
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1076
1076
  key?: string;
@@ -1078,9 +1078,9 @@ declare namespace gapi.client {
1078
1078
  oauth_token?: string;
1079
1079
  /** Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000. */
1080
1080
  pageSize?: number;
1081
- /** Optional. A token that identifies the page of results that the server should return. */
1081
+ /** Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result. */
1082
1082
  pageToken?: string;
1083
- /** Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} */
1083
+ /** Required. The framework compliance report to list control compliance summaries for. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
1084
1084
  parent: string;
1085
1085
  /** Returns response with indentations and line breaks. */
1086
1086
  prettyPrint?: boolean;
@@ -1093,7 +1093,7 @@ declare namespace gapi.client {
1093
1093
  }): Request<GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse>;
1094
1094
  }
1095
1095
  interface DbFrameworkComplianceReportsResource {
1096
- /** Gets the aggregated compliance report over time for a given scope. */
1096
+ /** Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope. */
1097
1097
  aggregate(request?: {
1098
1098
  /** V1 error format. */
1099
1099
  '$.xgafv'?: '1' | '2';
@@ -1105,7 +1105,7 @@ declare namespace gapi.client {
1105
1105
  callback?: string;
1106
1106
  /** Selector specifying which fields to include in a partial response. */
1107
1107
  fields?: string;
1108
- /** Optional. The filtering results. */
1108
+ /** Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework). */
1109
1109
  filter?: string;
1110
1110
  /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
1111
1111
  'interval.endTime'?: string;
@@ -1113,7 +1113,7 @@ declare namespace gapi.client {
1113
1113
  'interval.startTime'?: string;
1114
1114
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1115
1115
  key?: string;
1116
- /** Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
1116
+ /** Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
1117
1117
  name: string;
1118
1118
  /** OAuth 2.0 token for the current user. */
1119
1119
  oauth_token?: string;
@@ -1126,7 +1126,7 @@ declare namespace gapi.client {
1126
1126
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1127
1127
  uploadType?: string;
1128
1128
  }): Request<GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse>;
1129
- /** Fetches the framework compliance report for a given scope. */
1129
+ /** Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework. */
1130
1130
  fetch(request?: {
1131
1131
  /** V1 error format. */
1132
1132
  '$.xgafv'?: '1' | '2';
@@ -1136,15 +1136,15 @@ declare namespace gapi.client {
1136
1136
  alt?: 'json' | 'media' | 'proto';
1137
1137
  /** JSONP */
1138
1138
  callback?: string;
1139
- /** Optional. The end time of the report. */
1139
+ /** Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state. */
1140
1140
  endTime?: string;
1141
1141
  /** Selector specifying which fields to include in a partial response. */
1142
1142
  fields?: string;
1143
- /** Optional. The filtering results. */
1143
+ /** Optional. A filter expression that restricts the results. Reserved for future use. */
1144
1144
  filter?: string;
1145
1145
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1146
1146
  key?: string;
1147
- /** Required. The name of the framework compliance report to retrieve. */
1147
+ /** Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
1148
1148
  name: string;
1149
1149
  /** OAuth 2.0 token for the current user. */
1150
1150
  oauth_token?: string;
@@ -1160,7 +1160,7 @@ declare namespace gapi.client {
1160
1160
  dbControlComplianceSummaries: DbControlComplianceSummariesResource;
1161
1161
  }
1162
1162
  interface DbFrameworkComplianceSummariesResource {
1163
- /** Lists the framework compliance summary for a given scope. */
1163
+ /** Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project). */
1164
1164
  list(request?: {
1165
1165
  /** V1 error format. */
1166
1166
  '$.xgafv'?: '1' | '2';
@@ -1172,7 +1172,7 @@ declare namespace gapi.client {
1172
1172
  callback?: string;
1173
1173
  /** Selector specifying which fields to include in a partial response. */
1174
1174
  fields?: string;
1175
- /** Optional. The filtering results. */
1175
+ /** Optional. A filter expression that restricts the results. Reserved for future use. */
1176
1176
  filter?: string;
1177
1177
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1178
1178
  key?: string;
@@ -1180,9 +1180,9 @@ declare namespace gapi.client {
1180
1180
  oauth_token?: string;
1181
1181
  /** Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000. */
1182
1182
  pageSize?: number;
1183
- /** Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result. */
1183
+ /** Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result. */
1184
1184
  pageToken?: string;
1185
- /** Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} */
1185
+ /** Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}` */
1186
1186
  parent: string;
1187
1187
  /** Returns response with indentations and line breaks. */
1188
1188
  prettyPrint?: boolean;
@@ -1192,7 +1192,7 @@ declare namespace gapi.client {
1192
1192
  upload_protocol?: string;
1193
1193
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1194
1194
  uploadType?: string;
1195
- /** Optional. Specifies the level of detail to return in the response. */
1195
+ /** Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used. */
1196
1196
  view?:
1197
1197
  | 'FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED'
1198
1198
  | 'FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC'
@@ -1369,7 +1369,7 @@ declare namespace gapi.client {
1369
1369
  fields?: string;
1370
1370
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1371
1371
  key?: string;
1372
- /** Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} */
1372
+ /** Required. The resource name of the violation to acknowledge. Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}` */
1373
1373
  name: string;
1374
1374
  /** OAuth 2.0 token for the current user. */
1375
1375
  oauth_token?: string;
@@ -1398,7 +1398,7 @@ declare namespace gapi.client {
1398
1398
  fields?: string;
1399
1399
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1400
1400
  key?: string;
1401
- /** Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} */
1401
+ /** Required. The resource name of the violation to acknowledge. Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}` */
1402
1402
  name: string;
1403
1403
  /** OAuth 2.0 token for the current user. */
1404
1404
  oauth_token?: string;
@@ -1413,7 +1413,7 @@ declare namespace gapi.client {
1413
1413
  },
1414
1414
  body: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest,
1415
1415
  ): Request<{}>;
1416
- /** Retrieves Assured Workload Violation based on ID. */
1416
+ /** Retrieves an Assured Workloads violation by its resource name. */
1417
1417
  get(request?: {
1418
1418
  /** V1 error format. */
1419
1419
  '$.xgafv'?: '1' | '2';
@@ -1427,7 +1427,7 @@ declare namespace gapi.client {
1427
1427
  fields?: string;
1428
1428
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1429
1429
  key?: string;
1430
- /** Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} */
1430
+ /** Required. The resource name of the violation to retrieve (that is, the value of `Violation.name`). Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}` */
1431
1431
  name: string;
1432
1432
  /** OAuth 2.0 token for the current user. */
1433
1433
  oauth_token?: string;
@@ -1439,7 +1439,7 @@ declare namespace gapi.client {
1439
1439
  upload_protocol?: string;
1440
1440
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1441
1441
  uploadType?: string;
1442
- /** Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for fetching violations. */
1442
+ /** Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) that the violation belongs to. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used. */
1443
1443
  view?:
1444
1444
  | 'VIOLATION_VIEW_UNSPECIFIED'
1445
1445
  | 'VIOLATION_VIEW_ASSURED_WORKLOADS'
@@ -1457,7 +1457,7 @@ declare namespace gapi.client {
1457
1457
  callback?: string;
1458
1458
  /** Selector specifying which fields to include in a partial response. */
1459
1459
  fields?: string;
1460
- /** Optional. A custom filter for filtering by the Violations properties. */
1460
+ /** Optional. A filter expression that restricts the violations that are returned. The syntax follows [AIP-160](https://google.aip.dev/160). Only the equality operator (`=`) is supported, and expressions can be combined with `AND`, `OR`, and `NOT`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `violationId`, `category`, `state` (`UNRESOLVED`, `RESOLVED`, or `EXCEPTION`), `violationType` (`ORG_POLICY` or `RESOURCE`), `resourceType`, `resourceName`, `project`, `associatedOrgPolicyViolationId`, `cloudControlName`, `workloadDisplayName`, and `complianceType` (a framework ID). Example: `state = "UNRESOLVED" AND complianceType = "builtin-fedramp-high"` */
1461
1461
  filter?: string;
1462
1462
  /** The end of the time window. */
1463
1463
  'interval.endTime'?: string;
@@ -1467,13 +1467,13 @@ declare namespace gapi.client {
1467
1467
  key?: string;
1468
1468
  /** OAuth 2.0 token for the current user. */
1469
1469
  oauth_token?: string;
1470
- /** Optional. Actionable sorting delegation. */
1470
+ /** Optional. A comma-separated list of fields to sort the results by. The default sort order is ascending; to sort in descending order, append ` desc` to the field name. For example, `update_time desc,category`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `begin_time`, `update_time`, `resource_type`, `state`, and `category`. If not specified, results are sorted by `begin_time` in descending order. */
1471
1471
  orderBy?: string;
1472
- /** Optional. Page size. */
1472
+ /** Optional. The maximum number of violations to return. The service might return fewer violations than this value. If unspecified, at most 100 violations are returned. The maximum value is 1000; values above 1000 are coerced to 1000. */
1473
1473
  pageSize?: number;
1474
- /** Optional. Page token returned from previous request. */
1474
+ /** Optional. A page token, received from a previous `ListViolations` call. Provide this token to retrieve the subsequent page. When paginating, all other parameters that are provided to `ListViolations` must match the call that provided the page token. */
1475
1475
  pageToken?: string;
1476
- /** Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`. */
1476
+ /** Required. The workload to list violations for. To list violations across all workloads in an organization, use `-` as the workload ID. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, violations are listed for the entire organization and location, and the workload ID is ignored. Format: `organizations/{organization}/locations/{location}/workloads/{workload}` */
1477
1477
  parent: string;
1478
1478
  /** Returns response with indentations and line breaks. */
1479
1479
  prettyPrint?: boolean;
@@ -1483,7 +1483,7 @@ declare namespace gapi.client {
1483
1483
  upload_protocol?: string;
1484
1484
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1485
1485
  uploadType?: string;
1486
- /** Optional. Specifies the violation view(AssuredWorkloads or DataBoundary) for fetching violations. */
1486
+ /** Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) to list violations for. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used. */
1487
1487
  view?:
1488
1488
  | 'VIOLATION_VIEW_UNSPECIFIED'
1489
1489
  | 'VIOLATION_VIEW_ASSURED_WORKLOADS'
@@ -1923,7 +1923,7 @@ declare namespace gapi.client {
1923
1923
  locations: LocationsResource;
1924
1924
  }
1925
1925
  interface DbFindingSummariesResource {
1926
- /** Lists the finding summary by category for a given scope. */
1926
+ /** Lists summaries of the active findings in a Data Boundary scope (an organization, folder, or project), with one summary for each finding category. */
1927
1927
  list(request?: {
1928
1928
  /** V1 error format. */
1929
1929
  '$.xgafv'?: '1' | '2';
@@ -1935,7 +1935,7 @@ declare namespace gapi.client {
1935
1935
  callback?: string;
1936
1936
  /** Selector specifying which fields to include in a partial response. */
1937
1937
  fields?: string;
1938
- /** Optional. The filtering results. */
1938
+ /** Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework). */
1939
1939
  filter?: string;
1940
1940
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1941
1941
  key?: string;
@@ -1943,9 +1943,9 @@ declare namespace gapi.client {
1943
1943
  oauth_token?: string;
1944
1944
  /** Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. */
1945
1945
  pageSize?: number;
1946
- /** Optional. A token that identifies the page of results that the server should return. */
1946
+ /** Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result. */
1947
1947
  pageToken?: string;
1948
- /** Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location} */
1948
+ /** Required. The parent scope to list finding summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}` */
1949
1949
  parent: string;
1950
1950
  /** Returns response with indentations and line breaks. */
1951
1951
  prettyPrint?: boolean;
@@ -1958,7 +1958,7 @@ declare namespace gapi.client {
1958
1958
  }): Request<GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse>;
1959
1959
  }
1960
1960
  interface DbControlComplianceSummariesResource {
1961
- /** Lists the control compliance summary for a given scope. */
1961
+ /** Lists the compliance summaries of the controls in a framework compliance report. */
1962
1962
  list(request?: {
1963
1963
  /** V1 error format. */
1964
1964
  '$.xgafv'?: '1' | '2';
@@ -1970,7 +1970,7 @@ declare namespace gapi.client {
1970
1970
  callback?: string;
1971
1971
  /** Selector specifying which fields to include in a partial response. */
1972
1972
  fields?: string;
1973
- /** Optional. The filtering results. */
1973
+ /** Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = "2026-01-01T00:00:00Z"`. Only findings that were updated at or after this time are counted. */
1974
1974
  filter?: string;
1975
1975
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1976
1976
  key?: string;
@@ -1978,9 +1978,9 @@ declare namespace gapi.client {
1978
1978
  oauth_token?: string;
1979
1979
  /** Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000. */
1980
1980
  pageSize?: number;
1981
- /** Optional. A token that identifies the page of results that the server should return. */
1981
+ /** Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result. */
1982
1982
  pageToken?: string;
1983
- /** Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} */
1983
+ /** Required. The framework compliance report to list control compliance summaries for. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
1984
1984
  parent: string;
1985
1985
  /** Returns response with indentations and line breaks. */
1986
1986
  prettyPrint?: boolean;
@@ -1993,7 +1993,7 @@ declare namespace gapi.client {
1993
1993
  }): Request<GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse>;
1994
1994
  }
1995
1995
  interface DbFrameworkComplianceReportsResource {
1996
- /** Gets the aggregated compliance report over time for a given scope. */
1996
+ /** Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope. */
1997
1997
  aggregate(request?: {
1998
1998
  /** V1 error format. */
1999
1999
  '$.xgafv'?: '1' | '2';
@@ -2005,7 +2005,7 @@ declare namespace gapi.client {
2005
2005
  callback?: string;
2006
2006
  /** Selector specifying which fields to include in a partial response. */
2007
2007
  fields?: string;
2008
- /** Optional. The filtering results. */
2008
+ /** Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework). */
2009
2009
  filter?: string;
2010
2010
  /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
2011
2011
  'interval.endTime'?: string;
@@ -2013,7 +2013,7 @@ declare namespace gapi.client {
2013
2013
  'interval.startTime'?: string;
2014
2014
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2015
2015
  key?: string;
2016
- /** Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
2016
+ /** Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
2017
2017
  name: string;
2018
2018
  /** OAuth 2.0 token for the current user. */
2019
2019
  oauth_token?: string;
@@ -2026,7 +2026,7 @@ declare namespace gapi.client {
2026
2026
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2027
2027
  uploadType?: string;
2028
2028
  }): Request<GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse>;
2029
- /** Fetches the framework compliance report for a given scope. */
2029
+ /** Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework. */
2030
2030
  fetch(request?: {
2031
2031
  /** V1 error format. */
2032
2032
  '$.xgafv'?: '1' | '2';
@@ -2036,15 +2036,15 @@ declare namespace gapi.client {
2036
2036
  alt?: 'json' | 'media' | 'proto';
2037
2037
  /** JSONP */
2038
2038
  callback?: string;
2039
- /** Optional. The end time of the report. */
2039
+ /** Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state. */
2040
2040
  endTime?: string;
2041
2041
  /** Selector specifying which fields to include in a partial response. */
2042
2042
  fields?: string;
2043
- /** Optional. The filtering results. */
2043
+ /** Optional. A filter expression that restricts the results. Reserved for future use. */
2044
2044
  filter?: string;
2045
2045
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2046
2046
  key?: string;
2047
- /** Required. The name of the framework compliance report to retrieve. */
2047
+ /** Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` */
2048
2048
  name: string;
2049
2049
  /** OAuth 2.0 token for the current user. */
2050
2050
  oauth_token?: string;
@@ -2060,7 +2060,7 @@ declare namespace gapi.client {
2060
2060
  dbControlComplianceSummaries: DbControlComplianceSummariesResource;
2061
2061
  }
2062
2062
  interface DbFrameworkComplianceSummariesResource {
2063
- /** Lists the framework compliance summary for a given scope. */
2063
+ /** Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project). */
2064
2064
  list(request?: {
2065
2065
  /** V1 error format. */
2066
2066
  '$.xgafv'?: '1' | '2';
@@ -2072,7 +2072,7 @@ declare namespace gapi.client {
2072
2072
  callback?: string;
2073
2073
  /** Selector specifying which fields to include in a partial response. */
2074
2074
  fields?: string;
2075
- /** Optional. The filtering results. */
2075
+ /** Optional. A filter expression that restricts the results. Reserved for future use. */
2076
2076
  filter?: string;
2077
2077
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2078
2078
  key?: string;
@@ -2080,9 +2080,9 @@ declare namespace gapi.client {
2080
2080
  oauth_token?: string;
2081
2081
  /** Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000. */
2082
2082
  pageSize?: number;
2083
- /** Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result. */
2083
+ /** Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result. */
2084
2084
  pageToken?: string;
2085
- /** Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} */
2085
+ /** Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}` */
2086
2086
  parent: string;
2087
2087
  /** Returns response with indentations and line breaks. */
2088
2088
  prettyPrint?: boolean;
@@ -2092,7 +2092,7 @@ declare namespace gapi.client {
2092
2092
  upload_protocol?: string;
2093
2093
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2094
2094
  uploadType?: string;
2095
- /** Optional. Specifies the level of detail to return in the response. */
2095
+ /** Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used. */
2096
2096
  view?:
2097
2097
  | 'FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED'
2098
2098
  | 'FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC'
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.assuredworkloads-v1",
3
- "version": "0.3.20261015",
3
+ "version": "0.3.20261102",
4
4
  "description": "TypeScript typings for Assured Workloads API v1",
5
5
  "repository": {
6
6
  "type": "git",