Logo DataHubClient

PackagesApi Type

Client for GitLab Package Registry operations, focused on generic packages. See the .

Constructors

Constructor Description

PackagesApi(baseUrl, auth, http)

Full Usage: PackagesApi(baseUrl, auth, http)

Parameters:
Returns: PackagesApi
baseUrl : string
auth : Authentication
http : IHttpClient
Returns: PackagesApi

Instance members

Instance member Description

this.DownloadGenericFileAsync

Full Usage: this.DownloadGenericFileAsync

Parameters:
    projectId : int - The project identifier.
    packageName : string - The generic package name.
    version : string - The generic package version.
    fileName : string - The package file name.

Returns: Async<string>

Downloads a generic package file as text.

projectId : int

The project identifier.

packageName : string

The generic package name.

version : string

The generic package version.

fileName : string

The package file name.

Returns: Async<string>

this.DownloadROCrateAsync

Full Usage: this.DownloadROCrateAsync

Parameters:
    projectId : int - The ARC project's numeric identifier.

Returns: Async<string> The raw JSON-LD metadata text from the generated RO-Crate export.

Downloads a project's currently available generated main-branch ARC RO-Crate export as JSON-LD text. The export is not regenerated and is not guaranteed to represent the latest commit on the main branch.

Downloads arc-ro-crate-metadata.json from generic package isa_arc_json, version 0.0.1. Errors from the package download propagate, including missing exports and insufficient access.

projectId : int

The ARC project's numeric identifier.

Returns: Async<string>

The raw JSON-LD metadata text from the generated RO-Crate export.

this.GetAsync

Full Usage: this.GetAsync

Parameters:
    projectId : int - The project identifier.
    packageId : int - The package identifier.

Returns: Async<Package>

Gets a package by package identifier.

projectId : int

The project identifier.

packageId : int

The package identifier.

Returns: Async<Package>

this.ListAsync

Full Usage: this.ListAsync

Parameters:
    projectId : int - The project identifier.
    ?packageType : string - Optional package type filter, such as generic.
    ?packageName : string - Optional package-name filter.

Returns: Async<ResizeArray<Package>>

Lists packages for a project.

projectId : int

The project identifier.

?packageType : string

Optional package type filter, such as generic.

?packageName : string

Optional package-name filter.

Returns: Async<ResizeArray<Package>>

this.UploadGenericFileAsync

Full Usage: this.UploadGenericFileAsync

Parameters:
    projectId : int - The project identifier.
    packageName : string - The generic package name.
    version : string - The generic package version.
    fileName : string - The package file name.
    content : string - The file content to upload.

Returns: Async<string>

Uploads a generic package file.

projectId : int

The project identifier.

packageName : string

The generic package name.

version : string

The generic package version.

fileName : string

The package file name.

content : string

The file content to upload.

Returns: Async<string>

Type something to start searching.