utils.rc.client.env

Module Contents

Classes

EnvClient

Attributes

logger

utils.rc.client.env.logger
class utils.rc.client.env.EnvClient
static createEnv(name, description, envType, cores, memInMbs, diskInGbs, requirements, gpus, evergreen: bool = False, inactivity_in_hours: int = 0, async_flag: bool = False) → requests.Response
static updateEnv(envId, description, envType, cores, memInMbs, diskInGbs, requirements, gpus, evergreen: bool = False, inactivity_in_hours: int = 0, async_flag: bool = False) → requests.Response
pollEnvStatus(timeout: int = 300, interval: int = 3) → dict

Polls the environment status until launchStatus is SUCCESS or FAILED, or until timeout.

static customizeEnv(envId, cores, memInGb) → requests.Response

Customizes the environment configuration for the specified environment ID.

Parameters:

  • envId (str) – The ID of the environment to customize.

  • cores (int) – The number of CPU cores to allocate for the environment.

  • memInGb (int) – The amount of memory (in gigabytes) to allocate for the environment.

Returns:

The response object containing the result of the customization request.

Return type:

requests.Response

static getEnvByName(name)
static getEnvById(envId)
static deleteById(envId)
static getAllEnvs() → requests.Response