Logo DataHubClient

ValidationPackageRef Type

A reference to one validation package's result folder on an ARC's cqc branch, named <name>@<version> on disk. Instances are usually discovered via ValidationApi.ListPackagesAsync; use ValidationPackageRef.Create when the coordinates are already known. See the .

Constructors

Constructor Description

ValidationPackageRef(name, version, branch)

Full Usage: ValidationPackageRef(name, version, branch)

Parameters:
    name : string
    version : string
    branch : string

Returns: ValidationPackageRef
name : string
version : string
branch : string
Returns: ValidationPackageRef

Instance members

Instance member Description

this.Branch

Full Usage: this.Branch

Returns: string

The validated ARC branch whose results the folder holds (e.g. main).

Returns: string

this.Name

Full Usage: this.Name

Returns: string

The validation package name (e.g. invenio).

Returns: string

this.Path

Full Usage: this.Path

Returns: string

The result folder's path on the cqc branch, {Branch}/{Name}@{Version}.

Returns: string

this.Version

Full Usage: this.Version

Returns: string

The validation package version (semantic version string).

Returns: string

Static members

Static member Description

ValidationPackageRef.Create(name, version, ?branch)

Full Usage: ValidationPackageRef.Create(name, version, ?branch)

Parameters:
    name : string - The validation package name.
    version : string - The validation package version.
    ?branch : string - The validated ARC branch. Defaults to main.

Returns: ValidationPackageRef

Creates a reference from known coordinates, skipping discovery.

name : string

The validation package name.

version : string

The validation package version.

?branch : string

The validated ARC branch. Defaults to main.

Returns: ValidationPackageRef

Type something to start searching.