storage.configuration package¶
Subpackages¶
Submodules¶
storage.configuration.exceptions module¶
Defines exceptions that can occur when interacting with Workspace configuration
-
exception
storage.configuration.exceptions.InvalidWorkspaceConfiguration(name, description)¶ Bases:
util.exceptions.ValidationExceptionException indicating that the provided Workspace configuration was invalid
storage.configuration.workspace_configuration module¶
Defines the configuration for a storage Workspace
-
class
storage.configuration.workspace_configuration.WorkspaceConfiguration¶ Bases:
objectRepresents the configuration for a storage Workspace. The configuration includes details about the storage broker system required to read, write, move, or delete files within the workspace.
-
get_dict()¶ Returns the internal dictionary that represents this workspace configuration.
Returns: The internal dictionary Return type: dict
-
validate_broker()¶ Validates the current broker-specific configuration.
Returns: A list of warnings discovered during validation. Return type: list[ job.configuration.data.job_data.ValidationWarning]- :raises
storage.configuration.exceptions.InvalidWorkspaceConfiguration: If there is a configuration - problem.
- :raises
-