-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
assuredworkloads_v1.organizations.locations.workloads.html
639 lines (583 loc) 路 58.3 KB
/
assuredworkloads_v1.organizations.locations.workloads.html
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="assuredworkloads_v1.organizations.locations.workloads.violations.html">violations()</a></code>
</p>
<p class="firstline">Returns the violations Resource.</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="#create">create(parent, body=None, externalId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates Assured Workload.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, etag=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets Assured Workload associated with a CRM Node</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Assured Workloads under a CRM Node.</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>
<p class="toc_element">
<code><a href="#mutatePartnerPermissions">mutatePartnerPermissions(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.</p>
<p class="toc_element">
<code><a href="#restrictAllowedResources">restrictAllowedResources(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, externalId=None, x__xgafv=None)</code>
<pre>Creates Assured Workload.
Args:
parent: string, Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # A Workload object for managing highly regulated workloads of cloud customers.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Optional. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
}
externalId: string, Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, etag=None, x__xgafv=None)</code>
<pre>Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.
Args:
name: string, Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} (required)
etag: string, Optional. The etag of the workload. If this is provided, it must match the server's etag.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets Assured Workload associated with a CRM Node
Args:
name: string, Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Workload object for managing highly regulated workloads of cloud customers.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Optional. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Assured Workloads under a CRM Node.
Args:
parent: string, Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`. (required)
filter: string, A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.
pageSize: integer, Page size.
pageToken: string, Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response of ListWorkloads endpoint.
"nextPageToken": "A String", # The next page token. Return empty if reached the last page.
"workloads": [ # List of Workloads under a given parent.
{ # A Workload object for managing highly regulated workloads of cloud customers.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Optional. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
},
],
}</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>
<div class="method">
<code class="details" id="mutatePartnerPermissions">mutatePartnerPermissions(name, body=None, x__xgafv=None)</code>
<pre>Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
Args:
name: string, Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} (required)
body: object, The request body.
The object takes the form of:
{ # Request for updating permission settings for a partner workload.
"etag": "A String", # Optional. The etag of the workload. If this is provided, it must match the server's etag.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Required. The partner permissions to be updated.
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"updateMask": "A String", # Required. The list of fields to be updated. E.g. update_mask { paths: "partner_permissions.data_logs_viewer"}
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Workload object for managing highly regulated workloads of cloud customers.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Optional. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
Args:
name: string, Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. (required)
body: object, The request body.
The object takes the form of:
{ # A Workload object for managing highly regulated workloads of cloud customers.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Optional. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
}
updateMask: string, Required. The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Workload object for managing highly regulated workloads of cloud customers.
"billingAccount": "A String", # Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
"complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload.
"complianceStatus": { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
"acknowledgedViolationCount": 42, # Number of current orgPolicy violations which are acknowledged.
"activeViolationCount": 42, # Number of current orgPolicy violations which are not acknowledged.
},
"compliantButDisallowedServices": [ # Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
"A String",
],
"createTime": "A String", # Output only. Immutable. The Workload creation timestamp.
"displayName": "A String", # Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
"ekmProvisioningResponse": { # External key management systems(EKM) Provisioning response # Optional. Represents the Ekm Provisioning State of the given workload.
"ekmProvisioningErrorDomain": "A String", # Indicates Ekm provisioning error if any.
"ekmProvisioningErrorMapping": "A String", # Detailed error message if Ekm provisioning fails
"ekmProvisioningState": "A String", # Indicates Ekm enrollment Provisioning of a given workload.
},
"enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
"etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
"kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload.
"kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
"nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.
"rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.
},
"labels": { # Optional. Labels applied to the workload.
"a_key": "A String",
},
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
"partner": "A String", # Optional. Partner regime associated with this workload.
"partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload
"assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts.
"dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations.
"serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs.
},
"provisionedResourcesParent": "A String", # Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
"resourceSettings": [ # Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
{ # Represent the custom settings for the resources to be created.
"displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
"resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.
"resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)
},
],
"resources": [ # Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
{ # Represent the resources that are children of this Workload.
"resourceId": "A String", # Resource identifier. For a project this represents project_number.
"resourceType": "A String", # Indicates the type of resource.
},
],
"saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
"setupErrors": [ # Indicates SAA enrollment setup error if any.
"A String",
],
"setupStatus": "A String", # Indicates SAA enrollment status of a given workload.
},
"violationNotificationsEnabled": True or False, # Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
}</pre>
</div>
<div class="method">
<code class="details" id="restrictAllowedResources">restrictAllowedResources(name, body=None, x__xgafv=None)</code>
<pre>Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.
Args:
name: string, Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". (required)
body: object, The request body.
The object takes the form of:
{ # Request for restricting list of available resources in Workload environment.
"restrictionType": "A String", # Required. The type of restriction for using gcp products in the Workload environment.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for restricting the list of allowed resources.
}</pre>
</div>
</body></html>