storage.configuration.json package¶

Submodules¶

storage.configuration.json.workspace_config_1_0 module¶

Defines the JSON schema for a job configuration

class storage.configuration.json.workspace_config_1_0.WorkspaceConfigurationV1(configuration=None, do_validate=False)¶

Bases: object

Represents the schema for a workspace configuration

get_configuration()¶

Returns the workspace configuration represented by this JSON

Returns:	The workspace configuration
Return type:	`workspace.configuration.workspace_configuration.WorkspaceConfiguration`:

get_dict()¶

Returns the internal dictionary that represents this workspace configuration

Returns:	The internal dictionary
Return type:	dict

storage.configuration.json.workspace_config_v6 module¶

Manages the v6 job configuration schema

class storage.configuration.json.workspace_config_v6.WorkspaceConfigurationV6(config=None, do_validate=False)¶

Bases: object

Represents the schema for a workspace configuration

get_configuration()¶

Returns the workspace configuration represented by this JSON

Returns:	The workspace configuration
Return type:	`workspace.configuration.workspace_configuration.WorkspaceConfiguration`:

get_dict()¶

Returns the internal dictionary that represents this workspace configuration

Returns:	The internal dictionary
Return type:	dict

sanitize_credentials()¶: Sanitizes the aws credentials in the config if they exist

storage.configuration.json.workspace_config_v6.convert_config_to_v6_json(config, sanitize=True)¶

Returns the v6 workspace configuration JSON for the given configuration

Parameters:	config (`storage.configuration.workspace_configuration.WorkspaceConfiguration`) – The workspace configuration sanitize (bool) – Whether to sanitize credentials for display
Returns:	The v6 workspace configuration JSON
Return type:	`workspace.configuration.json.workspace_config_v6.WorkspaceConfigurationV6`

Module contents¶