Skip to content

Commit 38f6bdc

Browse files
feat(assuredworkloads): update the api
#### assuredworkloads:v1 The following keys were deleted: - schemas.GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata (Total Keys: 9) - schemas.GoogleCloudAssuredworkloadsV1beta1Workload (Total Keys: 63) - schemas.GoogleCloudAssuredworkloadsVersioningV1mainCreateWorkloadOperationMetadata (Total Keys: 9) - schemas.GoogleCloudAssuredworkloadsVersioningV1mainWorkload (Total Keys: 71) The following keys were added: - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.acknowledge (Total Keys: 12) - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.get (Total Keys: 11) - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.list (Total Keys: 24) - schemas.GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse (Total Keys: 2) - schemas.GoogleCloudAssuredworkloadsV1ListViolationsResponse (Total Keys: 5) - schemas.GoogleCloudAssuredworkloadsV1Violation (Total Keys: 55) #### assuredworkloads:v1beta1 The following keys were deleted: - schemas.GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata (Total Keys: 7) - schemas.GoogleCloudAssuredworkloadsV1Workload (Total Keys: 47) - schemas.GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata (Total Keys: 9) - schemas.GoogleCloudAssuredworkloadsVersioningV1beta1AnalyzeWorkloadMoveResponse (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsVersioningV1beta1ListViolationsResponse (Total Keys: 5) - schemas.GoogleCloudAssuredworkloadsVersioningV1beta1ListWorkloadsResponse (Total Keys: 5) - schemas.GoogleCloudAssuredworkloadsVersioningV1beta1Violation (Total Keys: 23) - schemas.GoogleCloudAssuredworkloadsVersioningV1beta1Workload (Total Keys: 71) - schemas.GoogleCloudAssuredworkloadsVersioningV1mainCreateWorkloadOperationMetadata (Total Keys: 9) - schemas.GoogleCloudAssuredworkloadsVersioningV1mainWorkload (Total Keys: 71) The following keys were added: - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.acknowledge (Total Keys: 12) - schemas.GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse (Total Keys: 2) - schemas.GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse (Total Keys: 4) - schemas.GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse (Total Keys: 5) - schemas.GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse (Total Keys: 5) - schemas.GoogleCloudAssuredworkloadsV1beta1Violation (Total Keys: 55) - schemas.GoogleCloudAssuredworkloadsV1beta1Workload.properties.complianceStatus (Total Keys: 2) - schemas.GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus (Total Keys: 6) The following keys were changed: - resources.organizations.resources.locations.resources.workloads.methods.get.response.$ref (Total Keys: 1) - resources.organizations.resources.locations.resources.workloads.methods.list.response.$ref (Total Keys: 1) - resources.organizations.resources.locations.resources.workloads.methods.patch.request.$ref (Total Keys: 1) - resources.organizations.resources.locations.resources.workloads.methods.patch.response.$ref (Total Keys: 1) - resources.organizations.resources.locations.resources.workloads.resources.organizations.resources.locations.resources.workloads.methods.analyzeWorkloadMove.response.$ref (Total Keys: 1) - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.get.response.$ref (Total Keys: 1) - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.list.response.$ref (Total Keys: 1) - resources.projects.resources.organizations.resources.locations.resources.workloads.methods.analyzeWorkloadMove.response.$ref (Total Keys: 1)
1 parent 6c1c884 commit 38f6bdc

6 files changed

+1087
-1976
lines changed

docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@
7474

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

0 commit comments

Comments
 (0)