Skip to content

Commit

Permalink
feat(assuredworkloads): update the api
Browse files Browse the repository at this point in the history
#### assuredworkloads:v1

The following keys were added:
- resources.organizations.resources.locations.resources.workloads.methods.mutatePartnerPermissions (Total Keys: 12)
- schemas.GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest (Total Keys: 5)
- schemas.GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions (Total Keys: 5)
  • Loading branch information
yoshi-automation committed Dec 6, 2022
1 parent 1277148 commit 0777a53
Show file tree
Hide file tree
Showing 3 changed files with 146 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@ <h2>Instance Methods</h2>
<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>
Expand Down Expand Up @@ -357,6 +360,80 @@ <h3>Method Details</h3>
</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&#x27;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 of updating permission settings for a partner workload.
&quot;etag&quot;: &quot;A String&quot;, # Optional. The etag of the workload. If this is provided, it must match the server&#x27;s etag.
&quot;partnerPermissions&quot;: { # Permissions granted to the AW Partner SA account for the customer workload # Required. The partner permissions to be updated.
&quot;dataLogsViewer&quot;: True or False, # Allow partner to view data and logs
&quot;remediateFolderViolations&quot;: True or False, # Allow partner to monitor folder and remediate violations
&quot;serviceAccessApprover&quot;: True or False, # Allow partner to approve or reject Service Access requests
},
&quot;updateMask&quot;: &quot;A String&quot;, # Required. The list of fields to be updated. E.g. update_mask { paths: &quot;partner_permissions.data_logs_viewer&quot;}
}

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.
&quot;billingAccount&quot;: &quot;A String&quot;, # 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`.
&quot;complianceRegime&quot;: &quot;A String&quot;, # Required. Immutable. Compliance Regime associated with this workload.
&quot;complianceStatus&quot;: { # Represents the Compliance Status of this workload # Output only. Count of active Violations in the Workload.
&quot;acknowledgedViolationCount&quot;: 42, # Count of active Violations which are acknowledged in the Workload.
&quot;activeViolationCount&quot;: 42, # Count of active Violations which haven&#x27;t been acknowledged.
},
&quot;compliantButDisallowedServices&quot;: [ # 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.&quot;
&quot;A String&quot;,
],
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Immutable. The Workload creation timestamp.
&quot;displayName&quot;: &quot;A String&quot;, # 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
&quot;enableSovereignControls&quot;: True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
&quot;etag&quot;: &quot;A String&quot;, # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update &amp; Delete operations.
&quot;kajEnrollmentState&quot;: &quot;A String&quot;, # Output only. Represents the KAJ enrollment state of the given workload.
&quot;kmsSettings&quot;: { # Settings specific to the Key Management Service. This message is deprecated. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. # 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.
&quot;nextRotationTime&quot;: &quot;A String&quot;, # 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.
&quot;rotationPeriod&quot;: &quot;A String&quot;, # 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.
},
&quot;labels&quot;: { # Optional. Labels applied to the workload.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
&quot;partner&quot;: &quot;A String&quot;, # Optional. Partner regime associated with this workload.
&quot;provisionedResourcesParent&quot;: &quot;A String&quot;, # 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}
&quot;resourceSettings&quot;: [ # 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.
&quot;displayName&quot;: &quot;A String&quot;, # User-assigned resource display name. If not empty it will be used to create a resource with the specified name.
&quot;resourceId&quot;: &quot;A String&quot;, # 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&#x27;t set this value as folder_id is assigned by Google.
&quot;resourceType&quot;: &quot;A String&quot;, # Indicates the type of resource. This field should be specified to correspond the id to the right resource type (CONSUMER_FOLDER or ENCRYPTION_KEYS_PROJECT)
},
],
&quot;resources&quot;: [ # 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.
&quot;resourceId&quot;: &quot;A String&quot;, # Resource identifier. For a project this represents project_number.
&quot;resourceType&quot;: &quot;A String&quot;, # Indicates the type of resource.
},
],
&quot;saaEnrollmentResponse&quot;: { # 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.
&quot;setupErrors&quot;: [ # Indicates SAA enrollment setup error if any.
&quot;A String&quot;,
],
&quot;setupStatus&quot;: &quot;A String&quot;, # Indicates SAA enrollment status of a given 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&#x27;t set etag field in the Workload. Only one update operation per workload can be in progress.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,34 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
"mutatePartnerPermissions": {
"description": "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.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions",
"httpMethod": "PATCH",
"id": "assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:mutatePartnerPermissions",
"request": {
"$ref": "GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest"
},
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1Workload"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "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.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
Expand Down Expand Up @@ -491,7 +519,7 @@
}
}
},
"revision": "20221110",
"revision": "20221205",
"rootUrl": "https://assuredworkloads.googleapis.com/",
"schemas": {
"GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": {
Expand Down Expand Up @@ -607,6 +635,26 @@
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest": {
"description": "Request of updating permission settings for a partner workload.",
"id": "GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest",
"properties": {
"etag": {
"description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.",
"type": "string"
},
"partnerPermissions": {
"$ref": "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions",
"description": "Required. The partner permissions to be updated."
},
"updateMask": {
"description": "Required. The list of fields to be updated. E.g. update_mask { paths: \"partner_permissions.data_logs_viewer\"}",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest": {
"description": "Request for restricting list of available resources in Workload environment.",
"id": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest",
Expand Down Expand Up @@ -1015,6 +1063,25 @@
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions": {
"description": "Permissions granted to the AW Partner SA account for the customer workload",
"id": "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions",
"properties": {
"dataLogsViewer": {
"description": "Allow partner to view data and logs",
"type": "boolean"
},
"remediateFolderViolations": {
"description": "Allow partner to monitor folder and remediate violations",
"type": "boolean"
},
"serviceAccessApprover": {
"description": "Allow partner to approve or reject Service Access requests",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1WorkloadResourceInfo": {
"description": "Represent the resources that are children of this Workload.",
"id": "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,7 @@
}
}
},
"revision": "20221110",
"revision": "20221205",
"rootUrl": "https://assuredworkloads.googleapis.com/",
"schemas": {
"GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": {
Expand Down

0 comments on commit 0777a53

Please sign in to comment.