Interface PolicyEvaluationRecord

This record encapsulates the current state of a policy as it applies to one specific pull request. Each pull request has a unique PolicyEvaluationRecord for each pull request which the policy applies to.

interface PolicyEvaluationRecord {
    _links?: any;
    artifactId?: string;
    completedDate?: Date;
    configuration?: PolicyConfiguration;
    context?: any;
    evaluationId?: string;
    startedDate?: Date;
    status?: PolicyEvaluationStatus;
}

Properties

_links? artifactId? completedDate? configuration? context? evaluationId? startedDate? status?

Properties

Optional_links

_links?: any

Links to other related objects

OptionalartifactId

artifactId?: string

A string which uniquely identifies the target of a policy evaluation.

OptionalcompletedDate

completedDate?: Date

Time when this policy finished evaluating on this pull request.

Optionalconfiguration

configuration?: PolicyConfiguration

Contains all configuration data for the policy which is being evaluated.

Optionalcontext

context?: any

Internal context data of this policy evaluation.

OptionalevaluationId

evaluationId?: string

Guid which uniquely identifies this evaluation record (one policy running on one pull request).

OptionalstartedDate

startedDate?: Date

Time when this policy was first evaluated on this pull request.

Optionalstatus

status?: PolicyEvaluationStatus

Status of the policy (Running, Approved, Failed, etc.)

Settings

Member Visibility

On This Page

Properties