REST Resource: projects.locations.evaluations.executions

Resource: Execution

Message describing Execution object

JSON representation 
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "inventoryTime": string,
  "state": enum (State),
  "evaluationId": string,
  "labels": {
    string: string,
    ...
  },
  "runType": enum (Type),
  "ruleResults": [
    {
      object (RuleExecutionResult)
    }
  ],
  "externalDataSources": [
    {
      object (ExternalDataSources)
    }
  ],
  "notices": [
    {
      object (Notice)
    }
  ],
  "resultSummary": {
    object (Summary)
  }
}
Fields
name

string

The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}
startTime

string (Timestamp format)

Output only. [Output only] Start 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".
endTime

string (Timestamp format)

Output only. [Output only] End 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".
inventoryTime

string (Timestamp format)

Output only. [Output only] Inventory 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".
state

enum (State)

Output only. [Output only] State
evaluationId

string

Output only. [Output only] Evaluation ID
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" }.
runType

enum (Type)

type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.
ruleResults[]

object (RuleExecutionResult)

Output only. execution result summary per rule
externalDataSources[]

object (ExternalDataSources)

Optional. External data sources
notices[]

object (Notice)

Output only. Additional information generated by the execution
resultSummary

object (Summary)

Output only. [Output only] Result summary for the execution

State

The state of execution

Enums
STATE_UNSPECIFIED state of execution is unspecified
RUNNING the execution is running in backend service
SUCCEEDED the execution run success
FAILED the execution run failed

Type

The type of execution, could be on demand execute or scheduled execute

Enums
TYPE_UNSPECIFIED type of execution is unspecified
ONE_TIME type of execution is one time
SCHEDULED type of execution is scheduled

RuleExecutionResult

Message for execution result summary per rule

JSON representation 
{
  "rule": string,
  "state": enum (State),
  "message": string,
  "resultCount": string,
  "scannedResourceCount": string
}
Fields
rule

string

rule name
state

enum (State)

Output only. The execution status
message

string

Execution message, if any
resultCount

string (int64 format)

Number of violations
scannedResourceCount

string (int64 format)

Number of total scanned resources

State

Execution state per rule

Enums
STATE_UNSPECIFIED Unknown state
STATE_SUCCESS execution completed successfully
STATE_FAILURE execution completed with failures
STATE_SKIPPED execution was not executed

ExternalDataSources

Message for external data sources

JSON representation 
{
  "name": string,
  "uri": string,
  "type": enum (Type),
  "assetType": string
}
Fields
name

string

Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data
uri

string

Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID}
type

enum (Type)

Required. Type of external data source
assetType

string

Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule

Type

Type of external data source

Enums
TYPE_UNSPECIFIED Unknown type
BIG_QUERY_TABLE BigQuery table

Notice

Message for additional information generated by the execution

JSON representation 
{
  "message": string
}
Fields
message

string

Output only. Message of the notice

Summary

Message for execution summary

JSON representation 
{
  "failures": string,
  "newFailures": string,
  "newFixes": string
}
Fields
failures

string (int64 format)

Output only. Number of failures
newFailures

string (int64 format)

Output only. Number of new failures compared to the previous execution
newFixes

string (int64 format)

Output only. Number of new fixes compared to the previous execution

Methods

delete

 Deletes a single Execution.

get

 Gets details of a single Execution.

list

 Lists Executions in a given project and location.

run

 Creates a new Execution in a given project and location.