1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="assuredworkloads_v1.html">Assured Workloads API</a> . <a href="assuredworkloads_v1.organizations.html">organizations</a> . <a href="assuredworkloads_v1.organizations.locations.html">locations</a> . <a href="assuredworkloads_v1.organizations.locations.workloads.html">workloads</a> . <a href="assuredworkloads_v1.organizations.locations.workloads.violations.html">violations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#acknowledge">acknowledge(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves Assured Workload Violation based on ID.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, interval_endTime=None, interval_startTime=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">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/-`</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="acknowledge">acknowledge(name, body=None, x__xgafv=None)</code>
<pre>Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.
Args:
name: string, Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} (required)
body: object, The request body.
The object takes the form of:
{ # Request for acknowledging the violation
"acknowledgeType": "A String", # Optional. Acknowledge type of specified violation.
"comment": "A String", # Required. Business justification explaining the need for violation acknowledgement
"nonCompliantOrgPolicy": "A String", # 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}
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for violation acknowledgement
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves Assured Workload Violation based on ID.
Args:
name: string, Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Workload monitoring Violation.
"acknowledged": True or False, # A boolean that indicates if the violation is acknowledged
"acknowledgementTime": "A String", # 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.
"associatedOrgPolicyViolationId": "A String", # Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations.
"auditLogLink": "A String", # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}
"beginTime": "A String", # Output only. Time of the event which triggered the Violation.
"category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.
"description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.
"exceptionAuditLogLink": "A String", # 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}
"exceptionContexts": [ # Output only. List of all the exception detail added for the violation.
{ # Violation exception detail.
"acknowledgementTime": "A String", # Timestamp when the violation was acknowledged.
"comment": "A String", # Business justification provided towards the acknowledgement of the violation.
"userName": "A String", # Name of the user (or service account) who acknowledged the violation.
},
],
"name": "A String", # Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}
"nonCompliantOrgPolicy": "A String", # 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}
"orgPolicyConstraint": "A String", # Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.
"parentProjectNumber": "A String", # Optional. Output only. Parent project number where resource is present. Empty for org-policy violations.
"remediation": { # Represents remediation guidance to resolve compliance violation for AssuredWorkload # Output only. Compliance violation remediation
"compliantValues": [ # Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values
"A String",
],
"instructions": { # Instructions to remediate violation # Required. Remediation instructions to resolve violations
"consoleInstructions": { # Remediation instructions to resolve violation via cloud console # Remediation instructions to resolve violation via cloud console
"additionalLinks": [ # Additional urls for more information about steps
"A String",
],
"consoleUris": [ # Link to console page where violations can be resolved
"A String",
],
"steps": [ # Steps to resolve violation via cloud console
"A String",
],
},
"gcloudInstructions": { # Remediation instructions to resolve violation via gcloud cli # Remediation instructions to resolve violation via gcloud cli
"additionalLinks": [ # Additional urls for more information about steps
"A String",
],
"gcloudCommands": [ # Gcloud command to resolve violation
"A String",
],
"steps": [ # Steps to resolve violation via gcloud cli
"A String",
],
},
},
"remediationType": "A String", # Output only. Reemediation type based on the type of org policy values violated
},
"resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.
"resourceName": "A String", # Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations.
"resourceType": "A String", # Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations.
"state": "A String", # Output only. State of the violation
"updateTime": "A String", # Output only. The last time when the Violation record was updated.
"violationType": "A String", # Output only. Type of the violation
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, interval_endTime=None, interval_startTime=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>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/-`
Args:
parent: string, Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`. (required)
filter: string, Optional. A custom filter for filtering by the Violations properties.
interval_endTime: string, The end of the time window.
interval_startTime: string, The start of the time window.
pageSize: integer, Optional. Page size.
pageToken: string, Optional. Page token returned from previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response of ListViolations endpoint.
"nextPageToken": "A String", # The next page token. Returns empty if reached the last page.
"violations": [ # List of Violations under a Workload.
{ # Workload monitoring Violation.
"acknowledged": True or False, # A boolean that indicates if the violation is acknowledged
"acknowledgementTime": "A String", # 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.
"associatedOrgPolicyViolationId": "A String", # Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations.
"auditLogLink": "A String", # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}
"beginTime": "A String", # Output only. Time of the event which triggered the Violation.
"category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.
"description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.
"exceptionAuditLogLink": "A String", # 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}
"exceptionContexts": [ # Output only. List of all the exception detail added for the violation.
{ # Violation exception detail.
"acknowledgementTime": "A String", # Timestamp when the violation was acknowledged.
"comment": "A String", # Business justification provided towards the acknowledgement of the violation.
"userName": "A String", # Name of the user (or service account) who acknowledged the violation.
},
],
"name": "A String", # Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}
"nonCompliantOrgPolicy": "A String", # 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}
"orgPolicyConstraint": "A String", # Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.
"parentProjectNumber": "A String", # Optional. Output only. Parent project number where resource is present. Empty for org-policy violations.
"remediation": { # Represents remediation guidance to resolve compliance violation for AssuredWorkload # Output only. Compliance violation remediation
"compliantValues": [ # Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values
"A String",
],
"instructions": { # Instructions to remediate violation # Required. Remediation instructions to resolve violations
"consoleInstructions": { # Remediation instructions to resolve violation via cloud console # Remediation instructions to resolve violation via cloud console
"additionalLinks": [ # Additional urls for more information about steps
"A String",
],
"consoleUris": [ # Link to console page where violations can be resolved
"A String",
],
"steps": [ # Steps to resolve violation via cloud console
"A String",
],
},
"gcloudInstructions": { # Remediation instructions to resolve violation via gcloud cli # Remediation instructions to resolve violation via gcloud cli
"additionalLinks": [ # Additional urls for more information about steps
"A String",
],
"gcloudCommands": [ # Gcloud command to resolve violation
"A String",
],
"steps": [ # Steps to resolve violation via gcloud cli
"A String",
],
},
},
"remediationType": "A String", # Output only. Reemediation type based on the type of org policy values violated
},
"resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.
"resourceName": "A String", # Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations.
"resourceType": "A String", # Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations.
"state": "A String", # Output only. State of the violation
"updateTime": "A String", # Output only. The last time when the Violation record was updated.
"violationType": "A String", # Output only. Type of the violation
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
