2022-09-20
▼ ▲ assuredworkloads.projects.organizations.locations.workloads.analyzeWorkloadMove
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.
Parameter Order:
Flat Path: v1beta1/projects/{projectsId}/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove
Path: v1beta1/{+project}/{+target}:analyzeWorkloadMove
Parameters:
source
Location: query
Type: string
Description: The source type is a project-based workload. Specify the workloads'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-1"
project
Description: 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.
Pattern: ^projects/[^/]+$
Location: path
Type: string
Required: Yes
target
Required: Yes
Description: Required. The resource ID of the folder-based destination workload. This workload is where the source project 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"
Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$
Location: path
Type: string
▼ ▲ assuredworkloads.organizations.locations.operations.get
Parameters:
name
Description: The name of the operation resource.
Location: path
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: GET
Path: v1beta1/{+name}
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ assuredworkloads.organizations.locations.operations.list
Parameter Order: name
Path: v1beta1/{+name}/operations
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations
Parameters:
name
Type: string
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+$
Location: path
Description: The name of the operation's parent resource.
filter
Location: query
Description: The standard list filter.
Type: string
pageSize
Type: integer
Location: query
Description: The standard list page size.
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
HTTP Method: GET
▼ ▲ assuredworkloads.organizations.locations.workloads.violations.list
Description: 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/-`
Parameter Order: parent
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations
Path: v1beta1/{+parent}/violations
Parameters:
interval.endTime
Description: The end of the time window.
Format: google-datetime
Location: query
Type: string
pageSize
Description: Optional. Page size.
Format: int32
Location: query
Type: integer
pageToken
Type: string
Location: query
Description: Optional. Page token returned from previous request.
parent
Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$
Required: Yes
Description: Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.
Location: path
Type: string
filter
Description: Optional. A custom filter for filtering by the Violations properties.
Type: string
Location: query
interval.startTime
Format: google-datetime
Description: The start of the time window.
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ assuredworkloads.organizations.locations.workloads.violations.get
Parameters:
name
Location: path
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$
Description: Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}
Type: string
Description: Retrieves Assured Workload Violation based on ID.
HTTP Method: GET
Path: v1beta1/{+name}
Parameter Order: name
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}
▼ ▲ assuredworkloads.organizations.locations.workloads.organizations.locations.workloads.analyzeWorkloadMove
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.
Parameter Order:
Path: v1beta1/{+source}/{+target}:analyzeWorkloadMove
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/organizations/{organizationsId1}/locations/{locationsId1}/workloads/{workloadsId1}:analyzeWorkloadMove
Parameters:
project
Description: 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.
Location: query
Type: string
source
Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$
Description: The source type is a project-based workload. Specify the workloads'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-1"
Required: Yes
Location: path
Type: string
target
Required: Yes
Location: path
Type: string
Description: Required. The resource ID of the folder-based destination workload. This workload is where the source project 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"
Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$
▼ ▲ assuredworkloads.organizations.locations.workloads.list
Parameter Order: parent
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Location: query
Type: string
Description: 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.
parent
Required: Yes
Type: string
Description: Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.
Location: path
Pattern: ^organizations/[^/]+/locations/[^/]+$
pageSize
Description: Page size.
Format: int32
Location: query
Type: integer
filter
Location: query
Type: string
Description: A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.
Path: v1beta1/{+parent}/workloads
Description: Lists Assured Workloads under a CRM Node.
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads
▼ ▲ assuredworkloads.organizations.locations.workloads.patch
Path: v1beta1/{+name}
Parameters:
updateMask
Location: query
Type: string
Description: Required. The list of fields to be updated.
Format: google-fieldmask
name
Type: string
Location: path
Required: Yes
Description: Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$
HTTP Method: PATCH
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ assuredworkloads.organizations.locations.workloads.get
Parameters:
name
Required: Yes
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$
Description: 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".
Location: path
Description: Gets Assured Workload associated with a CRM Node
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}
Parameter Order: name
HTTP Method: GET
▼ ▲ assuredworkloads.organizations.locations.workloads.create
Description: Creates Assured Workload.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads
Parameter Order: parent
HTTP Method: POST
Parameters:
parent
Location: path
Description: Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.
Pattern: ^organizations/[^/]+/locations/[^/]+$
Type: string
Required: Yes
externalId
Description: 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.
Type: string
Location: query
Path: v1beta1/{+parent}/workloads
▼ ▲ assuredworkloads.organizations.locations.workloads.restrictAllowedResources
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources
Description: 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.
HTTP Method: POST
Parameters:
name
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$
Description: 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".
Location: path
Type: string
Path: v1beta1/{+name}:restrictAllowedResources
Parameter Order: name
▼ ▲ assuredworkloads.organizations.locations.workloads.delete
Parameter Order: name
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}
HTTP Method: DELETE
Description: 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.
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Type: string
Description: Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}
Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$
Required: Yes
etag
Type: string
Location: query
Description: Optional. The etag of the workload. If this is provided, it must match the server's etag.