evaluations

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

Overview

Name	evaluations
Type	Resource
Id	google.workloadmanager.evaluations

Fields

Name	Datatype	Description
name	string	name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
description	string	Description of the Evaluation
bigQueryDestination	object	Message describing big query destination
createTime	string	Output only. [Output only] Create time stamp
customRulesBucket	string	The Cloud Storage bucket name for custom rules.
labels	object	Labels as key value pairs
resourceFilter	object	Message describing resource filters
resourceStatus	object	Message describing resource status
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	Output only. [Output only] Update time stamp

Methods

Name	Accessible by	Required Params	Description
get	SELECT	evaluationsId, locationsId, projectsId	Gets details of a single Evaluation.
list	SELECT	locationsId, projectsId	Lists Evaluations in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new Evaluation in a given project and location.
delete	DELETE	evaluationsId, locationsId, projectsId	Deletes a single Evaluation.

SELECT examples

Lists Evaluations in a given project and location.

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

INSERT example

Use the following StackQL query and manifest file to create a new evaluations resource.

All Properties

/*+ create */
INSERT INTO google.workloadmanager.evaluations (
locationsId,
projectsId,
name,
description,
resourceFilter,
ruleNames,
labels,
schedule,
customRulesBucket,
bigQueryDestination
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ description }}',
'{{ resourceFilter }}',
'{{ ruleNames }}',
'{{ labels }}',
'{{ schedule }}',
'{{ customRulesBucket }}',
'{{ bigQueryDestination }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: description
      value: string
    - name: resourceFilter
      value:
        - name: scopes
          value:
            - string
        - name: resourceIdPatterns
          value:
            - string
        - name: inclusionLabels
          value: object
        - name: gceInstanceFilter
          value:
            - name: serviceAccounts
              value:
                - string
    - name: ruleNames
      value:
        - string
    - name: ruleVersions
      value:
        - string
    - name: resourceStatus
      value:
        - name: rulesNewerVersions
          value:
            - string
        - name: state
          value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: schedule
      value: string
    - name: customRulesBucket
      value: string
    - name: bigQueryDestination
      value:
        - name: destinationDataset
          value: string
        - name: createNewResultsTable
          value: boolean

DELETE example

Deletes the specified evaluations resource.

/*+ delete */
DELETE FROM google.workloadmanager.evaluations
WHERE evaluationsId = '{{ evaluationsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';