Class CheckParameters

Namespace

OpaDotNet.Compilation.Cli

Assembly

OpaDotNet.Compilation.Cli.dll

Check parameters.

public record CheckParameters : IEquatable<CheckParameters>

Inheritance

object

CheckParameters

Implements

IEquatable<CheckParameters>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

CheckParameters()

public CheckParameters()

CheckParameters(CheckParameters)

protected CheckParameters(CheckParameters original)

Parameters

original CheckParameters

Properties

CapabilitiesBytes

Capabilities json that defines the built-in functions and other language features that policies may depend on.

public ReadOnlyMemory<byte> CapabilitiesBytes { get; init; }

Property Value

ReadOnlyMemory<byte>

CapabilitiesFilePath

Capabilities file that defines the built-in functions and other language features that policies may depend on. CapabilitiesFilePath overrides any other specified capabilities.

public string? CapabilitiesFilePath { get; init; }

Property Value

string

CapabilitiesVersion

OPA capabilities version. If set, compiler will merge capabilities of specified version with any additional custom capabilities.

public string? CapabilitiesVersion { get; init; }

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Format

Output format.

public CheckOutputFormat Format { get; init; }

Property Value

CheckOutputFormat

Ignore

Set file and directory names to ignore during loading (e.g., '.*' excludes hidden files).

public IReadOnlySet<string> Ignore { get; init; }

Property Value

IReadOnlySet<string>

IsBundle

Specifies if compilation source if file or bundle.

public bool IsBundle { get; init; }

Property Value

bool

MaxErrors

Set the number of errors to allow before compilation fails early (default 10).

public int? MaxErrors { get; init; }

Property Value

int?

RegoVersion

Sets OPA features and behaviors that will be enabled by default. V0 assumes --v0-compatible flag. V0CompatV1 assumes --v0-v1 flag.

public RegoVersion RegoVersion { get; init; }

Property Value

RegoVersion

Schema

Schema file path or directory path.

public string? Schema { get; init; }

Property Value

string

Strict

Enable compiler strict mode.

public bool Strict { get; init; }

Property Value

bool

Methods

Equals(CheckParameters?)

public virtual bool Equals(CheckParameters? other)

Parameters

other CheckParameters

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(CheckParameters?, CheckParameters?)

public static bool operator ==(CheckParameters? left, CheckParameters? right)

Parameters

left CheckParameters

right CheckParameters

Returns

bool

operator !=(CheckParameters?, CheckParameters?)

public static bool operator !=(CheckParameters? left, CheckParameters? right)

Parameters

left CheckParameters

right CheckParameters

Returns

bool