@maxim_mazurok/gapi.client.assuredworkloads-v1 0.3.20260921 → 0.3.20261006
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.
- package/index.d.ts +22 -149
- package/package.json +1 -1
- package/readme.md +1 -11
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:
|
|
12
|
+
// Revision: 20261006
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -38,6 +38,11 @@ declare namespace gapi.client {
|
|
|
38
38
|
comment?: string;
|
|
39
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} */
|
|
40
40
|
nonCompliantOrgPolicy?: string;
|
|
41
|
+
/** Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for acknowledging violations. */
|
|
42
|
+
view?:
|
|
43
|
+
| 'VIOLATION_VIEW_UNSPECIFIED'
|
|
44
|
+
| 'VIOLATION_VIEW_ASSURED_WORKLOADS'
|
|
45
|
+
| 'VIOLATION_VIEW_DATA_BOUNDARY';
|
|
41
46
|
}
|
|
42
47
|
interface GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse {}
|
|
43
48
|
interface GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse {
|
|
@@ -72,24 +77,6 @@ declare namespace gapi.client {
|
|
|
72
77
|
/** The update that was applied. */
|
|
73
78
|
appliedUpdate?: GoogleCloudAssuredworkloadsV1WorkloadUpdate;
|
|
74
79
|
}
|
|
75
|
-
interface GoogleCloudAssuredworkloadsV1ArchiveResourceEventsRequest {
|
|
76
|
-
/** Optional. Time to set as ArchiveTime in the archive table. If not provided, the current time is used. */
|
|
77
|
-
archiveTime?: string;
|
|
78
|
-
/** Required. The number of events to process in a single transaction batch. */
|
|
79
|
-
batchSize?: number;
|
|
80
|
-
/** Required. Only events with EventTime earlier than this cutoff will be archived. */
|
|
81
|
-
eventCutoffTime?: string;
|
|
82
|
-
/** Required. The maximum total number of events to move in this request. */
|
|
83
|
-
maxEventsMove?: number;
|
|
84
|
-
/** Required. The organization ID for which to archive events. */
|
|
85
|
-
organizationId?: string;
|
|
86
|
-
/** Required. The region of the workload(s) whose events should be archived. This is used to filter workloads based on AssurantWorkloadData.region. */
|
|
87
|
-
region?: string;
|
|
88
|
-
}
|
|
89
|
-
interface GoogleCloudAssuredworkloadsV1ArchiveResourceEventsResponse {
|
|
90
|
-
/** The total number of events successfully moved to the archive table. */
|
|
91
|
-
movedEventsCount?: number;
|
|
92
|
-
}
|
|
93
80
|
interface GoogleCloudAssuredworkloadsV1AssetMoveAnalysis {
|
|
94
81
|
/** List of eligible analyses performed for the asset. */
|
|
95
82
|
analysisGroups?: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup[];
|
|
@@ -474,24 +461,6 @@ declare namespace gapi.client {
|
|
|
474
461
|
| 'APPEND_COMPLIANT_RESOURCES';
|
|
475
462
|
}
|
|
476
463
|
interface GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse {}
|
|
477
|
-
interface GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsRequest {
|
|
478
|
-
/** Required. Only events within this time range will be reverted. This helps prevent reverting everything when something goes wrong. */
|
|
479
|
-
archiveEndTime?: string;
|
|
480
|
-
/** Required. Only events within this time range will be reverted. This helps prevent reverting everything when something goes wrong. */
|
|
481
|
-
archiveStartTime?: string;
|
|
482
|
-
/** Required. The number of events to process in a single transaction batch. */
|
|
483
|
-
batchSize?: number;
|
|
484
|
-
/** Required. The maximum total number of events to move in this request. */
|
|
485
|
-
maxEventsMove?: number;
|
|
486
|
-
/** Required. The organization ID for which to revert events. */
|
|
487
|
-
organizationId?: string;
|
|
488
|
-
/** Required. The region of the workload(s) whose events should be reverted. This is used to filter workloads based on AssurantWorkloadData.region. */
|
|
489
|
-
region?: string;
|
|
490
|
-
}
|
|
491
|
-
interface GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsResponse {
|
|
492
|
-
/** The total number of events successfully moved to the original table. */
|
|
493
|
-
movedEventsCount?: number;
|
|
494
|
-
}
|
|
495
464
|
interface GoogleCloudAssuredworkloadsV1Rule {
|
|
496
465
|
/** The rule's logic expression in Common Expression Language (CEL). */
|
|
497
466
|
celExpression?: GoogleCloudAssuredworkloadsV1CELExpression;
|
|
@@ -545,6 +514,8 @@ declare namespace gapi.client {
|
|
|
545
514
|
acknowledged?: boolean;
|
|
546
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. */
|
|
547
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". */
|
|
518
|
+
affectedFrameworks?: string[];
|
|
548
519
|
/** Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations. */
|
|
549
520
|
associatedOrgPolicyViolationId?: string;
|
|
550
521
|
/** Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} */
|
|
@@ -553,6 +524,8 @@ declare namespace gapi.client {
|
|
|
553
524
|
beginTime?: string;
|
|
554
525
|
/** Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. */
|
|
555
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. */
|
|
528
|
+
childResourceViolationCount?: number;
|
|
556
529
|
/** Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value. */
|
|
557
530
|
description?: string;
|
|
558
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} */
|
|
@@ -569,6 +542,8 @@ declare namespace gapi.client {
|
|
|
569
542
|
parentProjectNumber?: string;
|
|
570
543
|
/** Output only. Compliance violation remediation */
|
|
571
544
|
remediation?: GoogleCloudAssuredworkloadsV1ViolationRemediation;
|
|
545
|
+
/** Output only. Contains the remediation instructions for the violation in markdown format. */
|
|
546
|
+
remediationMarkdown?: string;
|
|
572
547
|
/** Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. */
|
|
573
548
|
resolveTime?: string;
|
|
574
549
|
/** Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations. */
|
|
@@ -862,116 +837,6 @@ declare namespace gapi.client {
|
|
|
862
837
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
863
838
|
message?: string;
|
|
864
839
|
}
|
|
865
|
-
interface AssuredworkloadsResource {
|
|
866
|
-
/** Finds orphan ResourceEvents matching the criteria and moves them to the ArchivedResourceEvents table. */
|
|
867
|
-
archiveResourceEvents(request: {
|
|
868
|
-
/** V1 error format. */
|
|
869
|
-
'$.xgafv'?: '1' | '2';
|
|
870
|
-
/** OAuth access token. */
|
|
871
|
-
access_token?: string;
|
|
872
|
-
/** Data format for response. */
|
|
873
|
-
alt?: 'json' | 'media' | 'proto';
|
|
874
|
-
/** JSONP */
|
|
875
|
-
callback?: string;
|
|
876
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
877
|
-
fields?: string;
|
|
878
|
-
/** 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. */
|
|
879
|
-
key?: string;
|
|
880
|
-
/** OAuth 2.0 token for the current user. */
|
|
881
|
-
oauth_token?: string;
|
|
882
|
-
/** Returns response with indentations and line breaks. */
|
|
883
|
-
prettyPrint?: boolean;
|
|
884
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
885
|
-
quotaUser?: string;
|
|
886
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
887
|
-
upload_protocol?: string;
|
|
888
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
889
|
-
uploadType?: string;
|
|
890
|
-
/** Request body */
|
|
891
|
-
resource: GoogleCloudAssuredworkloadsV1ArchiveResourceEventsRequest;
|
|
892
|
-
}): Request<GoogleCloudAssuredworkloadsV1ArchiveResourceEventsResponse>;
|
|
893
|
-
archiveResourceEvents(
|
|
894
|
-
request: {
|
|
895
|
-
/** V1 error format. */
|
|
896
|
-
'$.xgafv'?: '1' | '2';
|
|
897
|
-
/** OAuth access token. */
|
|
898
|
-
access_token?: string;
|
|
899
|
-
/** Data format for response. */
|
|
900
|
-
alt?: 'json' | 'media' | 'proto';
|
|
901
|
-
/** JSONP */
|
|
902
|
-
callback?: string;
|
|
903
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
904
|
-
fields?: string;
|
|
905
|
-
/** 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. */
|
|
906
|
-
key?: string;
|
|
907
|
-
/** OAuth 2.0 token for the current user. */
|
|
908
|
-
oauth_token?: string;
|
|
909
|
-
/** Returns response with indentations and line breaks. */
|
|
910
|
-
prettyPrint?: boolean;
|
|
911
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
912
|
-
quotaUser?: string;
|
|
913
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
914
|
-
upload_protocol?: string;
|
|
915
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
916
|
-
uploadType?: string;
|
|
917
|
-
},
|
|
918
|
-
body: GoogleCloudAssuredworkloadsV1ArchiveResourceEventsRequest,
|
|
919
|
-
): Request<GoogleCloudAssuredworkloadsV1ArchiveResourceEventsResponse>;
|
|
920
|
-
/** Finds matching ArchivedResourceEvents and moves them back to the ResourceEvents table. */
|
|
921
|
-
revertArchivedResourceEvents(request: {
|
|
922
|
-
/** V1 error format. */
|
|
923
|
-
'$.xgafv'?: '1' | '2';
|
|
924
|
-
/** OAuth access token. */
|
|
925
|
-
access_token?: string;
|
|
926
|
-
/** Data format for response. */
|
|
927
|
-
alt?: 'json' | 'media' | 'proto';
|
|
928
|
-
/** JSONP */
|
|
929
|
-
callback?: string;
|
|
930
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
931
|
-
fields?: string;
|
|
932
|
-
/** 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. */
|
|
933
|
-
key?: string;
|
|
934
|
-
/** OAuth 2.0 token for the current user. */
|
|
935
|
-
oauth_token?: string;
|
|
936
|
-
/** Returns response with indentations and line breaks. */
|
|
937
|
-
prettyPrint?: boolean;
|
|
938
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
939
|
-
quotaUser?: string;
|
|
940
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
941
|
-
upload_protocol?: string;
|
|
942
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
943
|
-
uploadType?: string;
|
|
944
|
-
/** Request body */
|
|
945
|
-
resource: GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsRequest;
|
|
946
|
-
}): Request<GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsResponse>;
|
|
947
|
-
revertArchivedResourceEvents(
|
|
948
|
-
request: {
|
|
949
|
-
/** V1 error format. */
|
|
950
|
-
'$.xgafv'?: '1' | '2';
|
|
951
|
-
/** OAuth access token. */
|
|
952
|
-
access_token?: string;
|
|
953
|
-
/** Data format for response. */
|
|
954
|
-
alt?: 'json' | 'media' | 'proto';
|
|
955
|
-
/** JSONP */
|
|
956
|
-
callback?: string;
|
|
957
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
958
|
-
fields?: string;
|
|
959
|
-
/** 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. */
|
|
960
|
-
key?: string;
|
|
961
|
-
/** OAuth 2.0 token for the current user. */
|
|
962
|
-
oauth_token?: string;
|
|
963
|
-
/** Returns response with indentations and line breaks. */
|
|
964
|
-
prettyPrint?: boolean;
|
|
965
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
966
|
-
quotaUser?: string;
|
|
967
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
968
|
-
upload_protocol?: string;
|
|
969
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
970
|
-
uploadType?: string;
|
|
971
|
-
},
|
|
972
|
-
body: GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsRequest,
|
|
973
|
-
): Request<GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsResponse>;
|
|
974
|
-
}
|
|
975
840
|
interface DbFindingSummariesResource {
|
|
976
841
|
/** Lists the finding summary by category for a given scope. */
|
|
977
842
|
list(request?: {
|
|
@@ -1574,6 +1439,11 @@ declare namespace gapi.client {
|
|
|
1574
1439
|
upload_protocol?: string;
|
|
1575
1440
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1576
1441
|
uploadType?: string;
|
|
1442
|
+
/** Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for fetching violations. */
|
|
1443
|
+
view?:
|
|
1444
|
+
| 'VIOLATION_VIEW_UNSPECIFIED'
|
|
1445
|
+
| 'VIOLATION_VIEW_ASSURED_WORKLOADS'
|
|
1446
|
+
| 'VIOLATION_VIEW_DATA_BOUNDARY';
|
|
1577
1447
|
}): Request<GoogleCloudAssuredworkloadsV1Violation>;
|
|
1578
1448
|
/** Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-` */
|
|
1579
1449
|
list(request?: {
|
|
@@ -1613,6 +1483,11 @@ declare namespace gapi.client {
|
|
|
1613
1483
|
upload_protocol?: string;
|
|
1614
1484
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1615
1485
|
uploadType?: string;
|
|
1486
|
+
/** Optional. Specifies the violation view(AssuredWorkloads or DataBoundary) for fetching violations. */
|
|
1487
|
+
view?:
|
|
1488
|
+
| 'VIOLATION_VIEW_UNSPECIFIED'
|
|
1489
|
+
| 'VIOLATION_VIEW_ASSURED_WORKLOADS'
|
|
1490
|
+
| 'VIOLATION_VIEW_DATA_BOUNDARY';
|
|
1616
1491
|
}): Request<GoogleCloudAssuredworkloadsV1ListViolationsResponse>;
|
|
1617
1492
|
}
|
|
1618
1493
|
interface WorkloadsResource {
|
|
@@ -2233,8 +2108,6 @@ declare namespace gapi.client {
|
|
|
2233
2108
|
locations: LocationsResource;
|
|
2234
2109
|
}
|
|
2235
2110
|
|
|
2236
|
-
const assuredworkloads: AssuredworkloadsResource;
|
|
2237
|
-
|
|
2238
2111
|
const folders: FoldersResource;
|
|
2239
2112
|
|
|
2240
2113
|
const organizations: OrganizationsResource;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -85,17 +85,7 @@ gapi.auth.authorize(
|
|
|
85
85
|
After that you can use Assured Workloads API resources: <!-- TODO: make this work for multiple namespaces -->
|
|
86
86
|
|
|
87
87
|
```typescript
|
|
88
|
-
|
|
89
|
-
Finds orphan ResourceEvents matching the criteria and moves them to the ArchivedResourceEvents table.
|
|
90
|
-
*/
|
|
91
|
-
await gapi.client.assuredworkloads.assuredworkloads.archiveResourceEvents({});
|
|
92
|
-
|
|
93
|
-
/*
|
|
94
|
-
Finds matching ArchivedResourceEvents and moves them back to the ResourceEvents table.
|
|
95
|
-
*/
|
|
96
|
-
await gapi.client.assuredworkloads.assuredworkloads.revertArchivedResourceEvents(
|
|
97
|
-
{},
|
|
98
|
-
);
|
|
88
|
+
|
|
99
89
|
```
|
|
100
90
|
|
|
101
91
|
For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.assuredworkloads-v1#Provenance:~:text=none-,Provenance,-Built%20and%20signed)
|