rules

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

Overview

Name	rules
Type	Resource
Id	google.workloadmanager.rules

Fields

The following fields are returned by SELECT queries:

list

Successful response

Name	Datatype	Description
name	string	rule name
description	string	descrite rule in plain language
displayName	string	the name display in UI
errorMessage	string	the message template for rule
primaryCategory	string	the primary category
remediation	string	the remediation for the rule
revisionId	string	Output only. the version of the rule
secondaryCategory	string	the secondary category
severity	string	the severity of the rule
tags	array	List of user-defined tags
uri	string	the docuement url for the rule

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, locationsId	pageSize, pageToken, filter, customRulesBucket, evaluationType	Lists rules in a given project.

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
locationsId	string
projectsId	string
customRulesBucket	string
evaluationType	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

list

Lists rules in a given project.

SELECT
name,
description,
displayName,
errorMessage,
primaryCategory,
remediation,
revisionId,
secondaryCategory,
severity,
tags,
uri
FROM google.workloadmanager.rules
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND customRulesBucket = '{{ customRulesBucket }}'
AND evaluationType = '{{ evaluationType }}';