workloads

Creates, updates, deletes, gets or lists a workloads resource.

Overview

Name	workloads
Type	Resource
Id	google.cloudcontrolspartner.workloads

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
createTime	string (google-datetime)	Output only. Time the resource was created.
folder	string	Output only. The name of container folder of the assured workload
folderId	string (int64)	Output only. Folder id this workload is associated with
isOnboarded	boolean	Indicates whether a workload is fully onboarded.
keyManagementProjectId	string	The project id of the key management project for the workload
location	string	The Google Cloud location of the workload
partner	string	Partner associated with this workload.
workloadOnboardingState	object	Container for workload onboarding steps. (id: WorkloadOnboardingState)

list

Successful response

Name	Datatype	Description
name	string	Identifier. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}
createTime	string (google-datetime)	Output only. Time the resource was created.
folder	string	Output only. The name of container folder of the assured workload
folderId	string (int64)	Output only. Folder id this workload is associated with
isOnboarded	boolean	Indicates whether a workload is fully onboarded.
keyManagementProjectId	string	The project id of the key management project for the workload
location	string	The Google Cloud location of the workload
partner	string	Partner associated with this workload.
workloadOnboardingState	object	Container for workload onboarding steps. (id: WorkloadOnboardingState)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	organizationsId, locationsId, customersId, workloadsId		Gets details of a single workload
list	select	organizationsId, locationsId, customersId	pageSize, pageToken, filter, orderBy	Lists customer workloads for a given customer org id

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
customersId	string
locationsId	string
organizationsId	string
workloadsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets details of a single workload

SELECT
name,
createTime,
folder,
folderId,
isOnboarded,
keyManagementProjectId,
location,
partner,
workloadOnboardingState
FROM google.cloudcontrolspartner.workloads
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND customersId = '{{ customersId }}' -- required
AND workloadsId = '{{ workloadsId }}' -- required;

list

Lists customer workloads for a given customer org id

SELECT
name,
createTime,
folder,
folderId,
isOnboarded,
keyManagementProjectId,
location,
partner,
workloadOnboardingState
FROM google.cloudcontrolspartner.workloads
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND customersId = '{{ customersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';