REST Resource: projects.locations.evaluations

Resource: Evaluation

LINT.IfChange Message describing Evaluation object

JSON representation
{
  "name": string,
  "description": string,
  "resourceFilter": {
    object (ResourceFilter)
  },
  "ruleNames": [
    string
  ],
  "ruleVersions": [
    string
  ],
  "resourceStatus": {
    object (ResourceStatus)
  },
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "customRulesBucket": string,
  "evaluationType": enum (EvaluationType),
  "schedule": string
}
Fields
name

string

name of resource names have the form 'projects/{projectId}/locations/{locationId}/evaluations/{evaluationId}'

description

string

Description of the Evaluation

resourceFilter

object (ResourceFilter)

annotations as key value pairs

ruleNames[]

string

the name of the rule

ruleVersions[]

string

Output only. [Output only] The updated rule ids if exist.

resourceStatus

object (ResourceStatus)

Output only. [Output only] The updated rule ids if exist.

createTime

string (Timestamp format)

Output only. [Output only] Create time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

customRulesBucket

string

The Cloud Storage bucket name for custom rules.

evaluationType

enum (EvaluationType)

Evaluation type

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 * *",

ResourceFilter

Message describing resource filters

JSON representation
{
  "scopes": [
    string
  ],
  "resourceIdPatterns": [
    string
  ],
  "inclusionLabels": {
    string: string,
    ...
  },
  "gceInstanceFilter": {
    object (GceInstanceFilter)
  }
}
Fields
scopes[]

string

The scopes of evaluation resource

resourceIdPatterns[]

string

The id pattern for filter resource

inclusionLabels

map (key: string, value: string)

The label used for filter resource

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

gceInstanceFilter

object (GceInstanceFilter)

Filter compute engine resource

GceInstanceFilter

Message describing compute engine instance filter

JSON representation
{
  "serviceAccounts": [
    string
  ]
}
Fields
serviceAccounts[]

string

Service account of compute engine

ResourceStatus

Message describing resource status

JSON representation
{
  "rulesNewerVersions": [
    string
  ],
  "state": enum (State)
}
Fields
rulesNewerVersions[]
(deprecated)

string

Historical: Used before 2023-05-22 the new version of rule id if exists

state

enum (State)

State of the resource

State

the State of Evaluation

Enums
STATE_UNSPECIFIED The state has not been populated in this message.
CREATING Resource has an active Create operation.
ACTIVE Resource has no outstanding operations on it or has active Update operations.
DELETING Resource has an active Delete operation.

EvaluationType

Evaluation type

Enums
EVALUATION_TYPE_UNSPECIFIED Not specified
SAP SAP best practices
SQL_SERVER SQL best practices
OTHER Customized best practices
SCC_IAC SCC IaC (Infra as Code) best practices

Methods

create

Creates a new Evaluation in a given project and location.

delete

Deletes a single Evaluation.

get

Gets details of a single Evaluation.

list

Lists Evaluations in a given project and location.

patch

Updates the parameters of a single Evaluation.