View source on GitHub |
Modules API module.
Modules
modules
module: Exposes methods to control services (modules) and versions of an app.
modules_stub
module: Stub implementation of the modules service.
Classes
class Error
: Base-class for errors in this module.
class InvalidInstancesError
: The given instances value is not valid.
class InvalidModuleError
: The given module is not known to the system.
class InvalidVersionError
: The given module version is not known to the system.
class TransientError
: A transient error was encountered, retry the operation.
class UnexpectedStateError
: An unexpected current state was found when starting/stopping a module.
Functions
get_current_instance_id(...)
: Returns the ID of the current instance.
get_current_module_name(...)
: Returns the module name of the current instance.
get_current_version_name(...)
: Returns the version of the current instance.
get_default_version(...)
: Returns the name of the default version for the module.
get_hostname(...)
: Returns a hostname to use to contact the module.
get_modules(...)
: Returns a list of all modules for the application.
get_num_instances(...)
: Return the number of instances that are set for the given module version.
get_versions(...)
: Returns a list of versions for a given module.
set_num_instances(...)
: Sets the number of instances on the module and version.
set_num_instances_async(...)
: Returns a UserRPC
to set the number of instances on the module version.
start_version(...)
: Start all instances for the given version of the module.
start_version_async(...)
: Returns a UserRPC
to start all instances for the given module version.
stop_version(...)
: Stops all instances for the given version of the module.
stop_version_async(...)
: Returns a UserRPC
to stop all instances for the given module version.