Skip to main content

PrivateGitHubCatalogOptions

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.ModelCatalogs

Defines the GitHub Options for private version of GitHub construction kit catalog

public class PrivateGitHubCatalogOptions : GitHubCatalogOptions, IGitHubOptions

Inheritance Object → CatalogOptions → GitHubCatalogOptions → PrivateGitHubCatalogOptions
Implements IGitHubOptions

Properties​

GitHubApiToken​

API Token for GitHub

public string GitHubApiToken { get; set; }

Property Value​

String

GitHubRepositoryName​

Name of the GitHub repository

public string GitHubRepositoryName { get; set; }

Property Value​

String

GitHubRepositoryOwner​

Owner of the GitHub repository

public string GitHubRepositoryOwner { get; set; }

Property Value​

String

GitHubRepositoryBranch​

GitHub repository branch

public string GitHubRepositoryBranch { get; set; }

Property Value​

String

GitHubPagesUri​

The uri to the GitHub pages site where the construction kit models are stored. If null or empty, the repository will use GitHub API for reading models.

public string GitHubPagesUri { get; set; }

Property Value​

String

ProductName​

Represents the product name to be used in the User-Agent header when making requests to GitHub API.

public string ProductName { get; set; }

Property Value​

String

IsEnabled​

When true, this GitHub catalog is enabled for reading and writing models.

public bool IsEnabled { get; set; }

Property Value​

Boolean

RefreshNotFoundRetryCount​

How often a catalog refresh retries reading an index file that is listed in the root catalog but answers 404. GitHub Pages briefly serves 404 while a deployment is being replaced (AB#4872), so a listed-but-missing index is usually transient. The count is a budget shared across one refresh, so a full site swap cannot stall a refresh for minutes.

public int RefreshNotFoundRetryCount { get; set; }

Property Value​

Int32

RefreshNotFoundRetryDelaySeconds​

Delay in seconds between the retries of GitHubCatalogOptions.RefreshNotFoundRetryCount.

public int RefreshNotFoundRetryDelaySeconds { get; set; }

Property Value​

Int32

CacheFileName​

Get or sets the cache file name for GitHub catalog

public string CacheFileName { get; set; }

Property Value​

String

CacheDirectory​

Gets or sets the cache directory for model catalogs

public string CacheDirectory { get; set; }

Property Value​

String

Constructors​

PrivateGitHubCatalogOptions()​

Initializes a new instance of the PublicGitHubCatalogOptions class.

public PrivateGitHubCatalogOptions()