Class DeploymentGateRuleEvaluationAttributes

Attributes of a deployment gate rule evaluation.

Hierarchy

  • DeploymentGateRuleEvaluationAttributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Evaluated rule configuration. Fields depend on rule type and unset fields are omitted. Monitor rules can include duration, query, monitor_ids, warmup, fail_on_no_groups_found, and fail_on_no_data. Faulty deployment detection rules can include duration, allowed_resources, and excluded_resources.

dryRun: boolean

Whether this rule is non-enforcing. A failed dry-run rule is ignored when computing the gate outcome. Independent of gate_dry_run.

durationSeconds: null | number

Rule evaluation duration in seconds. Null while it is in progress.

env: string

Evaluated environment.

evaluationId: string

Rule evaluation UUID. Matches the resource id.

Rule failure details.

finishedAt: null | Date

Time the rule evaluation finished. Null while it is in progress.

gateDryRun: boolean

Whether the parent gate is dry-run. A failed dry-run gate blocks but does not stop deployment. Independent of rule-level dry_run.

gateEvaluationId: string

Deployment gate evaluation UUID.

gateId: null | string

Configured deployment gate UUID. Null for just-in-time evaluations.

identifier: string

Deployment gate identifier.

name: string

Rule name.

reason: string

Reason for the rule result.

ruleId: null | string

Configured deployment rule UUID. Null for just-in-time rules.

service: string

Evaluated service.

startedAt: Date

Time the rule evaluation started.

The recorded result of a gate or rule evaluation.

  • in_progress: The evaluation is still running.
  • pass: All rules passed successfully.
  • fail: One or more rules did not pass.

Type of deployment gate rule.

version: string

Evaluated deployment version. Empty when no version was provided.

Generated using TypeDoc