@maxim_mazurok/gapi.client.assuredworkloads-v1beta1 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=v1beta1
|
|
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 GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse {}
|
|
43
48
|
interface GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse {
|
|
@@ -72,24 +77,6 @@ declare namespace gapi.client {
|
|
|
72
77
|
/** The update that was applied. */
|
|
73
78
|
appliedUpdate?: GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate;
|
|
74
79
|
}
|
|
75
|
-
interface GoogleCloudAssuredworkloadsV1beta1ArchiveResourceEventsRequest {
|
|
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 GoogleCloudAssuredworkloadsV1beta1ArchiveResourceEventsResponse {
|
|
90
|
-
/** The total number of events successfully moved to the archive table. */
|
|
91
|
-
movedEventsCount?: number;
|
|
92
|
-
}
|
|
93
80
|
interface GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis {
|
|
94
81
|
/** List of eligible analyses performed for the asset. */
|
|
95
82
|
analysisGroups?: GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup[];
|
|
@@ -468,24 +455,6 @@ declare namespace gapi.client {
|
|
|
468
455
|
| 'APPEND_COMPLIANT_RESOURCES';
|
|
469
456
|
}
|
|
470
457
|
interface GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse {}
|
|
471
|
-
interface GoogleCloudAssuredworkloadsV1beta1RevertArchivedResourceEventsRequest {
|
|
472
|
-
/** Required. Only events within this time range will be reverted. This helps prevent reverting everything when something goes wrong. */
|
|
473
|
-
archiveEndTime?: string;
|
|
474
|
-
/** Required. Only events within this time range will be reverted. This helps prevent reverting everything when something goes wrong. */
|
|
475
|
-
archiveStartTime?: string;
|
|
476
|
-
/** Required. The number of events to process in a single transaction batch. */
|
|
477
|
-
batchSize?: number;
|
|
478
|
-
/** Required. The maximum total number of events to move in this request. */
|
|
479
|
-
maxEventsMove?: number;
|
|
480
|
-
/** Required. The organization ID for which to revert events. */
|
|
481
|
-
organizationId?: string;
|
|
482
|
-
/** Required. The region of the workload(s) whose events should be reverted. This is used to filter workloads based on AssurantWorkloadData.region. */
|
|
483
|
-
region?: string;
|
|
484
|
-
}
|
|
485
|
-
interface GoogleCloudAssuredworkloadsV1beta1RevertArchivedResourceEventsResponse {
|
|
486
|
-
/** The total number of events successfully moved to the original table. */
|
|
487
|
-
movedEventsCount?: number;
|
|
488
|
-
}
|
|
489
458
|
interface GoogleCloudAssuredworkloadsV1beta1Rule {
|
|
490
459
|
/** The rule's logic expression in Common Expression Language (CEL). */
|
|
491
460
|
celExpression?: GoogleCloudAssuredworkloadsV1beta1CELExpression;
|
|
@@ -539,6 +508,8 @@ declare namespace gapi.client {
|
|
|
539
508
|
acknowledged?: boolean;
|
|
540
509
|
/** 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. */
|
|
541
510
|
acknowledgementTime?: string;
|
|
511
|
+
/** 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". */
|
|
512
|
+
affectedFrameworks?: string[];
|
|
542
513
|
/** Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations. */
|
|
543
514
|
associatedOrgPolicyViolationId?: string;
|
|
544
515
|
/** Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} */
|
|
@@ -547,6 +518,8 @@ declare namespace gapi.client {
|
|
|
547
518
|
beginTime?: string;
|
|
548
519
|
/** Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. */
|
|
549
520
|
category?: string;
|
|
521
|
+
/** Optional. Output only. The number of resource violations for particular org policy violation. This will be 0 in case of resource violation. */
|
|
522
|
+
childResourceViolationCount?: number;
|
|
550
523
|
/** Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value. */
|
|
551
524
|
description?: string;
|
|
552
525
|
/** 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} */
|
|
@@ -563,6 +536,8 @@ declare namespace gapi.client {
|
|
|
563
536
|
parentProjectNumber?: string;
|
|
564
537
|
/** Output only. Compliance violation remediation */
|
|
565
538
|
remediation?: GoogleCloudAssuredworkloadsV1beta1ViolationRemediation;
|
|
539
|
+
/** Output only. Contains the remediation instructions for the violation in markdown format. */
|
|
540
|
+
remediationMarkdown?: string;
|
|
566
541
|
/** Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. */
|
|
567
542
|
resolveTime?: string;
|
|
568
543
|
/** Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations. */
|
|
@@ -884,116 +859,6 @@ declare namespace gapi.client {
|
|
|
884
859
|
/** 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. */
|
|
885
860
|
message?: string;
|
|
886
861
|
}
|
|
887
|
-
interface AssuredworkloadsResource {
|
|
888
|
-
/** Finds orphan ResourceEvents matching the criteria and moves them to the ArchivedResourceEvents table. */
|
|
889
|
-
archiveResourceEvents(request: {
|
|
890
|
-
/** V1 error format. */
|
|
891
|
-
'$.xgafv'?: '1' | '2';
|
|
892
|
-
/** OAuth access token. */
|
|
893
|
-
access_token?: string;
|
|
894
|
-
/** Data format for response. */
|
|
895
|
-
alt?: 'json' | 'media' | 'proto';
|
|
896
|
-
/** JSONP */
|
|
897
|
-
callback?: string;
|
|
898
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
899
|
-
fields?: string;
|
|
900
|
-
/** 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. */
|
|
901
|
-
key?: string;
|
|
902
|
-
/** OAuth 2.0 token for the current user. */
|
|
903
|
-
oauth_token?: string;
|
|
904
|
-
/** Returns response with indentations and line breaks. */
|
|
905
|
-
prettyPrint?: boolean;
|
|
906
|
-
/** 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. */
|
|
907
|
-
quotaUser?: string;
|
|
908
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
909
|
-
upload_protocol?: string;
|
|
910
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
911
|
-
uploadType?: string;
|
|
912
|
-
/** Request body */
|
|
913
|
-
resource: GoogleCloudAssuredworkloadsV1beta1ArchiveResourceEventsRequest;
|
|
914
|
-
}): Request<GoogleCloudAssuredworkloadsV1beta1ArchiveResourceEventsResponse>;
|
|
915
|
-
archiveResourceEvents(
|
|
916
|
-
request: {
|
|
917
|
-
/** V1 error format. */
|
|
918
|
-
'$.xgafv'?: '1' | '2';
|
|
919
|
-
/** OAuth access token. */
|
|
920
|
-
access_token?: string;
|
|
921
|
-
/** Data format for response. */
|
|
922
|
-
alt?: 'json' | 'media' | 'proto';
|
|
923
|
-
/** JSONP */
|
|
924
|
-
callback?: string;
|
|
925
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
926
|
-
fields?: string;
|
|
927
|
-
/** 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. */
|
|
928
|
-
key?: string;
|
|
929
|
-
/** OAuth 2.0 token for the current user. */
|
|
930
|
-
oauth_token?: string;
|
|
931
|
-
/** Returns response with indentations and line breaks. */
|
|
932
|
-
prettyPrint?: boolean;
|
|
933
|
-
/** 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. */
|
|
934
|
-
quotaUser?: string;
|
|
935
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
936
|
-
upload_protocol?: string;
|
|
937
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
938
|
-
uploadType?: string;
|
|
939
|
-
},
|
|
940
|
-
body: GoogleCloudAssuredworkloadsV1beta1ArchiveResourceEventsRequest,
|
|
941
|
-
): Request<GoogleCloudAssuredworkloadsV1beta1ArchiveResourceEventsResponse>;
|
|
942
|
-
/** Finds matching ArchivedResourceEvents and moves them back to the ResourceEvents table. */
|
|
943
|
-
revertArchivedResourceEvents(request: {
|
|
944
|
-
/** V1 error format. */
|
|
945
|
-
'$.xgafv'?: '1' | '2';
|
|
946
|
-
/** OAuth access token. */
|
|
947
|
-
access_token?: string;
|
|
948
|
-
/** Data format for response. */
|
|
949
|
-
alt?: 'json' | 'media' | 'proto';
|
|
950
|
-
/** JSONP */
|
|
951
|
-
callback?: string;
|
|
952
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
953
|
-
fields?: string;
|
|
954
|
-
/** 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. */
|
|
955
|
-
key?: string;
|
|
956
|
-
/** OAuth 2.0 token for the current user. */
|
|
957
|
-
oauth_token?: string;
|
|
958
|
-
/** Returns response with indentations and line breaks. */
|
|
959
|
-
prettyPrint?: boolean;
|
|
960
|
-
/** 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. */
|
|
961
|
-
quotaUser?: string;
|
|
962
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
963
|
-
upload_protocol?: string;
|
|
964
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
965
|
-
uploadType?: string;
|
|
966
|
-
/** Request body */
|
|
967
|
-
resource: GoogleCloudAssuredworkloadsV1beta1RevertArchivedResourceEventsRequest;
|
|
968
|
-
}): Request<GoogleCloudAssuredworkloadsV1beta1RevertArchivedResourceEventsResponse>;
|
|
969
|
-
revertArchivedResourceEvents(
|
|
970
|
-
request: {
|
|
971
|
-
/** V1 error format. */
|
|
972
|
-
'$.xgafv'?: '1' | '2';
|
|
973
|
-
/** OAuth access token. */
|
|
974
|
-
access_token?: string;
|
|
975
|
-
/** Data format for response. */
|
|
976
|
-
alt?: 'json' | 'media' | 'proto';
|
|
977
|
-
/** JSONP */
|
|
978
|
-
callback?: string;
|
|
979
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
980
|
-
fields?: string;
|
|
981
|
-
/** 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. */
|
|
982
|
-
key?: string;
|
|
983
|
-
/** OAuth 2.0 token for the current user. */
|
|
984
|
-
oauth_token?: string;
|
|
985
|
-
/** Returns response with indentations and line breaks. */
|
|
986
|
-
prettyPrint?: boolean;
|
|
987
|
-
/** 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. */
|
|
988
|
-
quotaUser?: string;
|
|
989
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
990
|
-
upload_protocol?: string;
|
|
991
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
992
|
-
uploadType?: string;
|
|
993
|
-
},
|
|
994
|
-
body: GoogleCloudAssuredworkloadsV1beta1RevertArchivedResourceEventsRequest,
|
|
995
|
-
): Request<GoogleCloudAssuredworkloadsV1beta1RevertArchivedResourceEventsResponse>;
|
|
996
|
-
}
|
|
997
862
|
interface DbFindingSummariesResource {
|
|
998
863
|
/** Lists the finding summary by category for a given scope. */
|
|
999
864
|
list(request?: {
|
|
@@ -1596,6 +1461,11 @@ declare namespace gapi.client {
|
|
|
1596
1461
|
upload_protocol?: string;
|
|
1597
1462
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1598
1463
|
uploadType?: string;
|
|
1464
|
+
/** Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for fetching violations. */
|
|
1465
|
+
view?:
|
|
1466
|
+
| 'VIOLATION_VIEW_UNSPECIFIED'
|
|
1467
|
+
| 'VIOLATION_VIEW_ASSURED_WORKLOADS'
|
|
1468
|
+
| 'VIOLATION_VIEW_DATA_BOUNDARY';
|
|
1599
1469
|
}): Request<GoogleCloudAssuredworkloadsV1beta1Violation>;
|
|
1600
1470
|
/** 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/-` */
|
|
1601
1471
|
list(request?: {
|
|
@@ -1635,6 +1505,11 @@ declare namespace gapi.client {
|
|
|
1635
1505
|
upload_protocol?: string;
|
|
1636
1506
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1637
1507
|
uploadType?: string;
|
|
1508
|
+
/** Optional. Specifies the violation view(AssuredWorkloads or DataBoundary) for fetching violations. */
|
|
1509
|
+
view?:
|
|
1510
|
+
| 'VIOLATION_VIEW_UNSPECIFIED'
|
|
1511
|
+
| 'VIOLATION_VIEW_ASSURED_WORKLOADS'
|
|
1512
|
+
| 'VIOLATION_VIEW_DATA_BOUNDARY';
|
|
1638
1513
|
}): Request<GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse>;
|
|
1639
1514
|
}
|
|
1640
1515
|
interface WorkloadsResource {
|
|
@@ -2197,8 +2072,6 @@ declare namespace gapi.client {
|
|
|
2197
2072
|
locations: LocationsResource;
|
|
2198
2073
|
}
|
|
2199
2074
|
|
|
2200
|
-
const assuredworkloads: AssuredworkloadsResource;
|
|
2201
|
-
|
|
2202
2075
|
const folders: FoldersResource;
|
|
2203
2076
|
|
|
2204
2077
|
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-v1beta1#Provenance:~:text=none-,Provenance,-Built%20and%20signed)
|