oasislmf.cli.api

Classes

ServerInfoApiCmd	Print version/info details of the connected Oasis Platform API server
ListApiCmd	Issue API GET requests via the command line
RunApiCmd	Run a model via the Oasis Platform API end to end
RunInputApiCmd	Run a model via the Oasis Platform API end to end
RunLossApiCmd	Run a model via the Oasis Platform API end to end
DeleteApiCmd	Delete items from the Platform API
GetApiCmd	Download files from the Oasis Platform API
PostApiCmd	Upload file(s) to the Platform API
ValidateApiCmd	Validate (or fetch the validation status of) a portfolio's OED exposure files
ExposureRunApiCmd	Run oasislmf exposure run on the server against a portfolio's exposure files
ExposureTransformApiCmd	Convert a portfolio's exposure data between OED and AIR
CombineApiCmd	Combine the ORD output of multiple RUN_COMPLETED analyses
CancelApiCmd	Cancel a running analysis (input generation or execution)
ReconnectApiCmd	Reconnect to an in-progress (or finished) analysis and resume polling for status
SubTasksApiCmd	List the sub-tasks of an analysis run
PlotApiCmd	Plot a Gantt chart of an analysis's sub-tasks, with a status summary
ApiCmd	The base command to inherit from for each command.

Module Contents

class oasislmf.cli.api.ServerInfoApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Print version/info details of the connected Oasis Platform API server

formatter_class

computation_name = 'PlatformServerInfo'

class oasislmf.cli.api.ListApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Issue API GET requests via the command line

formatter_class

computation_name = 'PlatformList'

class oasislmf.cli.api.RunApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Run a model via the Oasis Platform API end to end

formatter_class

computation_name = 'PlatformRun'

class oasislmf.cli.api.RunInputApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Run a model via the Oasis Platform API end to end

formatter_class

computation_name = 'PlatformRunInputs'

class oasislmf.cli.api.RunLossApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Run a model via the Oasis Platform API end to end

formatter_class

computation_name = 'PlatformRunLosses'

class oasislmf.cli.api.DeleteApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Delete items from the Platform API

formatter_class

computation_name = 'PlatformDelete'

class oasislmf.cli.api.GetApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Download files from the Oasis Platform API

formatter_class

computation_name = 'PlatformGet'

class oasislmf.cli.api.PostApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Upload file(s) to the Platform API

formatter_class

computation_name = 'PlatformPost'

class oasislmf.cli.api.ValidateApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Validate (or fetch the validation status of) a portfolio’s OED exposure files

formatter_class

computation_name = 'PlatformValidate'

class oasislmf.cli.api.ExposureRunApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Run oasislmf exposure run on the server against a portfolio’s exposure files

formatter_class

computation_name = 'PlatformExposureRun'

class oasislmf.cli.api.ExposureTransformApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Convert a portfolio’s exposure data between OED and AIR

formatter_class

computation_name = 'PlatformExposureTransform'

class oasislmf.cli.api.CombineApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Combine the ORD output of multiple RUN_COMPLETED analyses

formatter_class

computation_name = 'PlatformCombine'

class oasislmf.cli.api.CancelApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Cancel a running analysis (input generation or execution)

formatter_class

computation_name = 'PlatformCancel'

class oasislmf.cli.api.ReconnectApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Reconnect to an in-progress (or finished) analysis and resume polling for status

formatter_class

computation_name = 'PlatformReconnect'

class oasislmf.cli.api.SubTasksApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

List the sub-tasks of an analysis run

formatter_class

computation_name = 'PlatformSubTasks'

class oasislmf.cli.api.PlotApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisComputationCommand

Plot a Gantt chart of an analysis’s sub-tasks, with a status summary

formatter_class

computation_name = 'PlatformPlot'

class oasislmf.cli.api.ApiCmd(*args, **kwargs)

Bases: oasislmf.cli.command.OasisBaseCommand

The base command to inherit from for each command.

2 additional arguments (--verbose and --config) are added to the parser so that they are available for all commands.

sub_commands