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)
    }
  ]
}
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

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
}
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

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

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.