Skip to main content

BlueprintCatalogException

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.BlueprintCatalogs

Exception thrown when a blueprint catalog operation fails

public class BlueprintCatalogException : Exception, ISerializable

Inheritance Object → Exception → BlueprintCatalogException
Implements ISerializable

Properties​

TargetSite​

public MethodBase TargetSite { get; }

Property Value​

MethodBase

Message​

public string Message { get; }

Property Value​

String

Data​

public IDictionary Data { get; }

Property Value​

IDictionary

InnerException​

public Exception InnerException { get; }

Property Value​

Exception

public string HelpLink { get; set; }

Property Value​

String

Source​

public string Source { get; set; }

Property Value​

String

HResult​

public int HResult { get; set; }

Property Value​

Int32

StackTrace​

public string StackTrace { get; }

Property Value​

String

Constructors​

BlueprintCatalogException(String)​

Creates a new instance of BlueprintCatalogException

public BlueprintCatalogException(string message)

Parameters​

message String
The exception message

BlueprintCatalogException(String, Exception)​

Creates a new instance of BlueprintCatalogException

public BlueprintCatalogException(string message, Exception innerException)

Parameters​

message String
The exception message

innerException Exception
The inner exception

Methods​

BlueprintNotFound(BlueprintId)​

Creates an exception for a blueprint not found error

public static BlueprintCatalogException BlueprintNotFound(BlueprintId blueprintId)

Parameters​

blueprintId BlueprintId
The blueprint id that was not found

Returns​

BlueprintCatalogException
A new exception instance

BlueprintNotFoundInCatalog(String, BlueprintId)​

Creates an exception for a blueprint not found in catalog error

public static BlueprintCatalogException BlueprintNotFoundInCatalog(string catalogName, BlueprintId blueprintId)

Parameters​

catalogName String
The catalog name

blueprintId BlueprintId
The blueprint id that was not found

Returns​

BlueprintCatalogException
A new exception instance

CatalogNotFound(String)​

Creates an exception for a catalog not found error

public static BlueprintCatalogException CatalogNotFound(string catalogName)

Parameters​

catalogName String
The catalog name that was not found

Returns​

BlueprintCatalogException
A new exception instance

CatalogCannotRead(String)​

Creates an exception for a catalog read error

public static BlueprintCatalogException CatalogCannotRead(string catalogName)

Parameters​

catalogName String
The catalog name

Returns​

BlueprintCatalogException
A new exception instance

CatalogCannotWrite(String)​

Creates an exception for a catalog write error

public static BlueprintCatalogException CatalogCannotWrite(string catalogName)

Parameters​

catalogName String
The catalog name

Returns​

BlueprintCatalogException
A new exception instance

BlueprintAlreadyExists(BlueprintId)​

Creates an exception for a blueprint already exists error

public static BlueprintCatalogException BlueprintAlreadyExists(BlueprintId blueprintId)

Parameters​

blueprintId BlueprintId
The blueprint id that already exists

Returns​

BlueprintCatalogException
A new exception instance

CircularBlueprintReference(BlueprintId)​

Creates an exception for a circular blueprint reference error

public static BlueprintCatalogException CircularBlueprintReference(BlueprintId blueprintId)

Parameters​

blueprintId BlueprintId
The blueprint id causing the circular reference

Returns​

BlueprintCatalogException
A new exception instance

InvalidGitHubRepository(String, String)​

Creates an exception for an invalid GitHub repository error

public static BlueprintCatalogException InvalidGitHubRepository(string catalogName, string gitHubPagesUri)

Parameters​

catalogName String
The catalog name

gitHubPagesUri String
The GitHub Pages URI

Returns​

BlueprintCatalogException
A new exception instance

RequestTimeout(String, String)​

Creates an exception for a request timeout error

public static BlueprintCatalogException RequestTimeout(string catalogName, string gitHubPagesUri)

Parameters​

catalogName String
The catalog name

gitHubPagesUri String
The GitHub Pages URI

Returns​

BlueprintCatalogException
A new exception instance

GitHubPagesUriMissing()​

Creates an exception for a missing GitHub Pages URI error

public static BlueprintCatalogException GitHubPagesUriMissing()

Returns​

BlueprintCatalogException
A new exception instance

ErrorDuringBlueprintLoad(BlueprintId, String, OperationResult)​

Creates an exception for an error during blueprint load

public static BlueprintCatalogException ErrorDuringBlueprintLoad(BlueprintId blueprintId, string catalogName, OperationResult operationResult)

Parameters​

blueprintId BlueprintId
The blueprint id

catalogName String
The catalog name

operationResult OperationResult
The operation result with errors

Returns​

BlueprintCatalogException
A new exception instance

GitHubTokenMissing()​

Creates an exception for a missing GitHub API token error

public static BlueprintCatalogException GitHubTokenMissing()

Returns​

BlueprintCatalogException
A new exception instance

PublishFailed(BlueprintId, String, Exception)​

Creates an exception for a publish failure

public static BlueprintCatalogException PublishFailed(BlueprintId blueprintId, string catalogName, Exception innerException)

Parameters​

blueprintId BlueprintId
The blueprint id

catalogName String
The catalog name

innerException Exception
The inner exception

Returns​

BlueprintCatalogException
A new exception instance

UnpublishFailed(BlueprintId, String, Exception)​

Creates an exception for an unpublish failure

public static BlueprintCatalogException UnpublishFailed(BlueprintId blueprintId, string catalogName, Exception innerException)

Parameters​

blueprintId BlueprintId
The blueprint id

catalogName String
The catalog name

innerException Exception
The inner exception

Returns​

BlueprintCatalogException
A new exception instance

UnpublishAllFailed(String, String, Exception)​

Creates an exception for a failure while removing all versions of a blueprint.

public static BlueprintCatalogException UnpublishAllFailed(string blueprintName, string catalogName, Exception innerException)

Parameters​

blueprintName String
The blueprint name (all versions)

catalogName String
The catalog name

innerException Exception
The inner exception

Returns​

BlueprintCatalogException
A new exception instance

CannotReadExistingVersionsCatalog(BlueprintId, String, String)​

Creates an exception for when an existing version catalog cannot be read

public static BlueprintCatalogException CannotReadExistingVersionsCatalog(BlueprintId blueprintId, string catalogName, string catalogPath)

Parameters​

blueprintId BlueprintId
The blueprint id

catalogName String
The catalog name

catalogPath String
The catalog path

Returns​

BlueprintCatalogException
A new exception instance

CannotReadExistingLibraryCatalog(BlueprintId, String, String)​

Creates an exception for when an existing library catalog cannot be read

public static BlueprintCatalogException CannotReadExistingLibraryCatalog(BlueprintId blueprintId, string catalogName, string catalogPath)

Parameters​

blueprintId BlueprintId
The blueprint id

catalogName String
The catalog name

catalogPath String
The catalog path

Returns​

BlueprintCatalogException
A new exception instance

BlueprintAlreadyExistsInCatalog(BlueprintId, String)​

Creates an exception for a blueprint already exists in catalog error

public static BlueprintCatalogException BlueprintAlreadyExistsInCatalog(BlueprintId blueprintId, string catalogName)

Parameters​

blueprintId BlueprintId
The blueprint id that already exists

catalogName String
The catalog name

Returns​

BlueprintCatalogException
A new exception instance

BlueprintFileNotFound(BlueprintId, String, String)​

Creates an exception for a file that does not exist inside a blueprint's folder. Returns the dedicated BlueprintFileNotFoundException subtype so soft-not-found call sites can distinguish it from other catalog failures without inspecting the message.

public static BlueprintFileNotFoundException BlueprintFileNotFound(BlueprintId blueprintId, string catalogName, string relativePath)

Parameters​

blueprintId BlueprintId
The blueprint id

catalogName String
The catalog name

relativePath String
The relative path of the missing file

Returns​

BlueprintFileNotFoundException
A new exception instance

InvalidBlueprintRelativePath(String)​

Creates an exception for an invalid relative path in a blueprint file lookup.

public static BlueprintCatalogException InvalidBlueprintRelativePath(string relativePath)

Parameters​

relativePath String
The offending relative path

Returns​

BlueprintCatalogException
A new exception instance