evaluations

Creates, updates, deletes, gets or lists an evaluations resource.

Overview

Name	evaluations
Type	Resource
Id	google.workloadmanager.evaluations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
bigQueryDestination	object	Optional. BigQuery destination (id: BigQueryDestination)
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
customRulesBucket	string	The Cloud Storage bucket name for custom rules.
description	string	Description of the Evaluation
evaluationType	string	Evaluation type
kmsKey	string	Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/.
labels	object	Labels as key value pairs
resourceFilter	object	annotations as key value pairs (id: ResourceFilter)
resourceStatus	object	Output only. [Output only] The updated rule ids if exist. (id: ResourceStatus)
ruleNames	array	the name of the rule
ruleVersions	array	Output only. [Output only] The updated rule ids if exist.
schedule	string	crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp

list

Name	Datatype	Description
name	string	name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
bigQueryDestination	object	Optional. BigQuery destination (id: BigQueryDestination)
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
customRulesBucket	string	The Cloud Storage bucket name for custom rules.
description	string	Description of the Evaluation
evaluationType	string	Evaluation type
kmsKey	string	Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/.
labels	object	Labels as key value pairs
resourceFilter	object	annotations as key value pairs (id: ResourceFilter)
resourceStatus	object	Output only. [Output only] The updated rule ids if exist. (id: ResourceStatus)
ruleNames	array	the name of the rule
ruleVersions	array	Output only. [Output only] The updated rule ids if exist.
schedule	string	crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, evaluationsId		Gets details of a single Evaluation.
list	select	projectsId, locationsId	pageSize, pageToken, orderBy, filter	Lists Evaluations in a given project and location.
create	insert	projectsId, locationsId	evaluationId, requestId	Creates a new Evaluation in a given project and location.
patch	update	projectsId, locationsId, evaluationsId	requestId, updateMask	Updates the parameters of a single Evaluation.
delete	delete	projectsId, locationsId, evaluationsId	requestId, force	Deletes a single Evaluation.

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
evaluationsId	string
locationsId	string
projectsId	string
evaluationId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Evaluation.

SELECT
name,
bigQueryDestination,
createTime,
customRulesBucket,
description,
evaluationType,
kmsKey,
labels,
resourceFilter,
resourceStatus,
ruleNames,
ruleVersions,
schedule,
updateTime
FROM google.workloadmanager.evaluations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND evaluationsId = '{{ evaluationsId }}' -- required
;

list

Lists Evaluations in a given project and location.

SELECT
name,
bigQueryDestination,
createTime,
customRulesBucket,
description,
evaluationType,
kmsKey,
labels,
resourceFilter,
resourceStatus,
ruleNames,
ruleVersions,
schedule,
updateTime
FROM google.workloadmanager.evaluations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
;

INSERT examples

create

Creates a new Evaluation in a given project and location.

INSERT INTO google.workloadmanager.evaluations (
data__kmsKey,
data__schedule,
data__ruleNames,
data__resourceFilter,
data__labels,
data__bigQueryDestination,
data__description,
data__name,
data__customRulesBucket,
data__evaluationType,
projectsId,
locationsId,
evaluationId,
requestId
)
SELECT 
'{{ kmsKey }}',
'{{ schedule }}',
'{{ ruleNames }}',
'{{ resourceFilter }}',
'{{ labels }}',
'{{ bigQueryDestination }}',
'{{ description }}',
'{{ name }}',
'{{ customRulesBucket }}',
'{{ evaluationType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ evaluationId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: evaluations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the evaluations resource.
    - name: locationsId
      value: string
      description: Required parameter for the evaluations resource.
    - name: kmsKey
      value: string
      description: >
        Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
        
    - name: schedule
      value: string
      description: >
        crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
        
    - name: ruleNames
      value: array
      description: >
        the name of the rule
        
    - name: resourceFilter
      value: object
      description: >
        annotations as key value pairs
        
    - name: labels
      value: object
      description: >
        Labels as key value pairs
        
    - name: bigQueryDestination
      value: object
      description: >
        Optional. BigQuery destination
        
    - name: description
      value: string
      description: >
        Description of the Evaluation
        
    - name: name
      value: string
      description: >
        name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
        
    - name: customRulesBucket
      value: string
      description: >
        The Cloud Storage bucket name for custom rules.
        
    - name: evaluationType
      value: string
      description: >
        Evaluation type
        
      valid_values: ['EVALUATION_TYPE_UNSPECIFIED', 'SAP', 'SQL_SERVER', 'OTHER', 'SCC_IAC']
    - name: evaluationId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a single Evaluation.

UPDATE google.workloadmanager.evaluations
SET 
data__kmsKey = '{{ kmsKey }}',
data__schedule = '{{ schedule }}',
data__ruleNames = '{{ ruleNames }}',
data__resourceFilter = '{{ resourceFilter }}',
data__labels = '{{ labels }}',
data__bigQueryDestination = '{{ bigQueryDestination }}',
data__description = '{{ description }}',
data__name = '{{ name }}',
data__customRulesBucket = '{{ customRulesBucket }}',
data__evaluationType = '{{ evaluationType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND evaluationsId = '{{ evaluationsId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Evaluation.

DELETE FROM google.workloadmanager.evaluations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND evaluationsId = '{{ evaluationsId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}'
;