REST Resource: projects.locations.evaluations

Resource: Evaluation

Represents a Workload Manager Evaluation configuration. An Evaluation defines a set of rules to be validated against a scope of Cloud resources.

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

string

Name of resource that has the form projects/{projectId}/locations/{locationId}/evaluations/{evaluationId}.
description

string

Description of the Evaluation.
resourceFilter

object (ResourceFilter)

Resource filter for an evaluation defining the scope of resources to be evaluated.
ruleNames[]

string

The names of the rules used for this evaluation.
resourceStatus

object (ResourceStatus)

Output only. [Output only] The current lifecycle state of the evaluation resource.
createTime

string (Timestamp format)

Output only. [Output only] Create time stamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
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.
bigQueryDestination

object (BigQueryDestination)

Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery.
kmsKey

string

Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. The key will be used for CMEK encryption of the evaluation resource.
schedule

string

Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * 0 */1 * * * # Hourly * 0 */6 * * * # Every 6 hours * 0 */12 * * * # Every 12 hours * 0 0 */1 * * # Daily * 0 0 */7 * * # Weekly * 0 0 */14 * * # Every 14 days * 0 0 1 */1 * # Monthly

ResourceFilter

Resource filter for an evaluation defining the scope of resources to be evaluated.

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

string

The scopes of evaluation resource. Format: * projects/{projectId} * folders/{folderId} * organizations/{organizationId}
resourceIdPatterns[]

string

The pattern to filter resources by their id For example, a pattern of ".*prod-cluster.*" will match all resources that contain "prod-cluster" in their ID.
inclusionLabels

map (key: string, value: string)

Labels to filter resources by. Each key-value pair in the map must exist on the resource for it to be included (e.g. VM instance labels). For example, specifying { "env": "prod", "database": "nosql" } will only include resources that have labels env=prod and database=nosql.

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

object (GceInstanceFilter)

Filter compute engine resources.

GceInstanceFilter

A filter for matching Compute Engine instances.

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

string

If non-empty, only Compute Engine instances associated with at least one of the provided service accounts will be included in the evaluation.

ResourceStatus

The lifecycle status of an Evaluation resource.

JSON representation 
{
  "state": enum (State)
}
Fields
state

enum (State)

State of the Evaluation resource.

State

Possible states of an evaluation, such as CREATING, ACTIVE, and DELETING.

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

Possible types of workload evaluations like SAP, SQL Server, etc.

Enums
EVALUATION_TYPE_UNSPECIFIED Not specified.
SAP SAP best practices.
SQL_SERVER SQL best practices.
OTHER Customized best practices.

BigQueryDestination

BigQuery destination for evaluation results.

JSON representation 
{
  "destinationDataset": string,
  "createNewResultsTable": boolean
}
Fields
destinationDataset

string

Optional. Destination dataset to save evaluation results.
createNewResultsTable

boolean

Optional. Determines if a new results table will be created when an Execution is created.

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.