You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="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>
<pclass="firstline">This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.</p>
<pclass="firstline">Enable resource violation monitoring for a workload.</p>
@@ -123,7 +131,7 @@ <h3>Method Details</h3>
123
131
Args:
124
132
target: string, Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" (required)
125
133
assetTypes: string, Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). (repeated)
126
-
pageSize: integer, Optional. Page size. If a value is not specified, the default value of 10 is used.
134
+
pageSize: integer, Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.
127
135
pageToken: string, Optional. The page token from the previous response. It needs to be passed in the second and following requests.
128
136
project: string, The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.
<pre>This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.
327
+
328
+
Args:
329
+
name: string, Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} (required)
330
+
x__xgafv: string, V1 error format.
331
+
Allowed values
332
+
1 - v1 error format
333
+
2 - v2 error format
334
+
335
+
Returns:
336
+
An object of the form:
337
+
338
+
{ # Response for EnableComplianceUpdates endpoint.
<pre>This endpoint creates a new operation to apply the given update.
93
+
94
+
Args:
95
+
name: string, Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id} (required)
96
+
body: object, The request body.
97
+
The object takes the form of:
98
+
99
+
{ # Request to apply update to a workload.
100
+
"action": "A String", # The action to be performed on the update.
101
+
}
102
+
103
+
x__xgafv: string, V1 error format.
104
+
Allowed values
105
+
1 - v1 error format
106
+
2 - v2 error format
107
+
108
+
Returns:
109
+
An object of the form:
110
+
111
+
{ # This resource represents a long-running operation that is the result of a network API call.
112
+
"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.
113
+
"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.
114
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
115
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
116
+
{
117
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
118
+
},
119
+
],
120
+
"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.
121
+
},
122
+
"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.
123
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
124
+
},
125
+
"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}`.
126
+
"response": { # The normal, successful response of the operation. 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`.
127
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
pageSize: integer, Page size. The default value is 20 and the max allowed value is 100.
144
+
pageToken: string, Page token returned from previous request.
145
+
x__xgafv: string, V1 error format.
146
+
Allowed values
147
+
1 - v1 error format
148
+
2 - v2 error format
149
+
150
+
Returns:
151
+
An object of the form:
152
+
153
+
{ # Response of listing the compliance updates per workload with pagination.
154
+
"nextPageToken": "A String", # The next page token. Return empty if reached the last page.
155
+
"workloadUpdates": [ # The list of workload updates for a given workload.
156
+
{ # A workload update is a change to the workload's compliance configuration.
157
+
"createTime": "A String", # The time the update was created.
158
+
"details": { # The details of the update. # The details of the update.
159
+
"orgPolicyUpdate": { # Represents an update for an org policy control applied on an Assured Workload resource. The inherited org policy is not considered. # Update to one org policy, e.g. gcp.resourceLocation.
160
+
"appliedPolicy": { # This assured workload service object is used to represent the org policy attached to a resource. It servces the same purpose as the orgpolicy.v2.Policy object but with functionality that is limited to what is supported by Assured Workloads(e.g. only one rule under one OrgPolicy object, no conditions, etc). # The org policy currently applied on the assured workload resource.
161
+
"constraint": "A String", # The constraint name of the OrgPolicy. e.g. "constraints/gcp.resourceLocations".
162
+
"inherit": True or False, # If `inherit` is true, policy rules of the lowest ancestor in the resource hierarchy chain are inherited. If it is false, policy rules are not inherited.
163
+
"reset": True or False, # Ignores policies set above this resource and restores to the `constraint_default` value. `reset` can only be true when `rules` is empty and `inherit` is false.
164
+
"resource": "A String", # Resource that the OrgPolicy attaches to. Format: folders/123" projects/123".
165
+
"rule": { # A rule used to express this policy. # The rule of the OrgPolicy.
166
+
"allowAll": True or False, # ListPolicy only when all values are allowed.
167
+
"denyAll": True or False, # ListPolicy only when all values are denied.
168
+
"enforce": True or False, # BooleanPolicy only.
169
+
"values": { # The values allowed for a ListPolicy. # ListPolicy only when custom values are specified.
170
+
"allowedValues": [ # List of values allowed at this resource.
171
+
"A String",
172
+
],
173
+
"deniedValues": [ # List of values denied at this resource.
174
+
"A String",
175
+
],
176
+
},
177
+
},
178
+
},
179
+
"suggestedPolicy": { # This assured workload service object is used to represent the org policy attached to a resource. It servces the same purpose as the orgpolicy.v2.Policy object but with functionality that is limited to what is supported by Assured Workloads(e.g. only one rule under one OrgPolicy object, no conditions, etc). # The suggested org policy that replaces the applied policy.
180
+
"constraint": "A String", # The constraint name of the OrgPolicy. e.g. "constraints/gcp.resourceLocations".
181
+
"inherit": True or False, # If `inherit` is true, policy rules of the lowest ancestor in the resource hierarchy chain are inherited. If it is false, policy rules are not inherited.
182
+
"reset": True or False, # Ignores policies set above this resource and restores to the `constraint_default` value. `reset` can only be true when `rules` is empty and `inherit` is false.
183
+
"resource": "A String", # Resource that the OrgPolicy attaches to. Format: folders/123" projects/123".
184
+
"rule": { # A rule used to express this policy. # The rule of the OrgPolicy.
185
+
"allowAll": True or False, # ListPolicy only when all values are allowed.
186
+
"denyAll": True or False, # ListPolicy only when all values are denied.
187
+
"enforce": True or False, # BooleanPolicy only.
188
+
"values": { # The values allowed for a ListPolicy. # ListPolicy only when custom values are specified.
189
+
"allowedValues": [ # List of values allowed at this resource.
190
+
"A String",
191
+
],
192
+
"deniedValues": [ # List of values denied at this resource.
193
+
"A String",
194
+
],
195
+
},
196
+
},
197
+
},
198
+
},
199
+
},
200
+
"name": "A String", # Output only. Immutable. Identifier. Resource name of the WorkloadUpdate. Format: organizations/{organization}/locations/{location}/workloads/{workload}/updates/{update}
201
+
"state": "A String", # Output only. The state of the update.
202
+
"updateTime": "A String", # The time the update was last updated.
Copy file name to clipboardExpand all lines: docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -128,7 +128,7 @@ <h3>Method Details</h3>
128
128
Args:
129
129
target: string, Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" (required)
130
130
assetTypes: string, Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). (repeated)
131
-
pageSize: integer, Optional. Page size. If a value is not specified, the default value of 10 is used.
131
+
pageSize: integer, Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.
132
132
pageToken: string, Optional. The page token from the previous response. It needs to be passed in the second and following requests.
133
133
project: string, The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.
0 commit comments