foundry_dev_tools.errors.compass module

Compass specific errors.

exception foundry_dev_tools.errors.compass.ResourceNotFoundError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Resource not found.'

exception foundry_dev_tools.errors.compass.FolderNotFoundError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Compass folder not found.'

exception foundry_dev_tools.errors.compass.MarkingNotFoundError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Marking not found.'

exception foundry_dev_tools.errors.compass.WrongResourceTypeError

Bases: FoundryDevToolsError

Thrown when wrong resource type is requested while creating a Resource.

__init__(rid, path, resource_type)

Parameters:

• rid (api_types.Rid)

• path (api_types.FoundryPath)

• resource_type (type[Resource])

exception foundry_dev_tools.errors.compass.TooManyResourcesRequestedError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Too many resource rids have been requested in one batch.'

exception foundry_dev_tools.errors.compass.NotProjectError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The project rid is not a project.'

exception foundry_dev_tools.errors.compass.ForbiddenOperationOnServiceProjectResourceError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The given project is a service project resource and the provided bearer token does not have compass:write-service-project operation.'

exception foundry_dev_tools.errors.compass.InsufficientPermissionsError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The user has insufficient permissions to and requires operations.'

exception foundry_dev_tools.errors.compass.AutosaveResourceOperationForbiddenError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The resource is an autosave resource.'

exception foundry_dev_tools.errors.compass.ForbiddenOperationOnHiddenResourceError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The resource is a hidden resource.'

exception foundry_dev_tools.errors.compass.InvalidMarkingError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Marking is a multipass organization marking which can only be applied to projects, tag categories and collections.'

exception foundry_dev_tools.errors.compass.PathNotFoundError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Some component of the path does not exist and hence could not be found.'

exception foundry_dev_tools.errors.compass.UsersNamespaceOperationForbiddenError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'It is not possible to update resources within the own Users namespace.'

exception foundry_dev_tools.errors.compass.GatekeeperInsufficientPermissionsError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The user does not have the permissions to create the project.'

exception foundry_dev_tools.errors.compass.DuplicateNameError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'A project already exists holding the same name.'

exception foundry_dev_tools.errors.compass.IllegalNameError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The project name is illegal. Ensure that it does not contain any illegal characters.'

exception foundry_dev_tools.errors.compass.UnrecognizedAccessLevelError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Permissions on project are invalid regarding the access level.'

exception foundry_dev_tools.errors.compass.UnrecognizedPatchOperationError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Permissions on project are invalid regarding the patch operation.'

exception foundry_dev_tools.errors.compass.UnrecognizedPrincipalError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Permissions on project are invalid regarding the principal.'

exception foundry_dev_tools.errors.compass.OrganizationNotFoundError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The requested organization marking does not exist.'

exception foundry_dev_tools.errors.compass.InvalidOrganizationMarkingHierarchyError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The requested marking would cause an invalid hierarchy state.'

exception foundry_dev_tools.errors.compass.MissingOrganizationMarkingError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Exception is thrown when the requested organization marking(s) is missing on the parent.'

exception foundry_dev_tools.errors.compass.InvalidMavenProductIdError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The provided maven product id is invalid.'

exception foundry_dev_tools.errors.compass.MavenProductIdAlreadySetError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The provided maven product id is either empty or already set and does not correspond with the provided value.'

exception foundry_dev_tools.errors.compass.MavenProductIdConflictError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Another project is already associated with this maven group.'

exception foundry_dev_tools.errors.compass.InvalidMavenGroupPrefixError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = "Portfolio's maven group is not the maven group of the product id."

exception foundry_dev_tools.errors.compass.ResourceNotTrashedError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Resource needs to be trashed before deleting it.'

exception foundry_dev_tools.errors.compass.CircularDependencyError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'Cannot move resources to destination which is one of its children.'

exception foundry_dev_tools.errors.compass.CannotMoveResourcesUnderHiddenResourceError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = 'The destination is a hidden resource.'

exception foundry_dev_tools.errors.compass.UnexpectedParentError

Bases: FoundryAPIError

Initialize a Foundry API error.

Parameters:

• response – requests Response where the API error occured

• info – add additional information to this error

• kwargs – error specific parameters which may contain more information about the error

message = "A parent is specified that does not match the resource's current parent."