Skip to content

System Args

These system arguments have defaults for every job type. They can be overwritten as described in the Introduction. Not all system arguments apply to every job type, e.g. python tasks do not use the java_* arguments and locally run tasks to not use the ecs_* arguments.

SystemArgs

Bases: BaseModel

Parameters:

Name Type Description Default
task_language TaskLanguage
required
general_task_id str | None
None
task_count int
0
use_api bool
required
java_threads int | None
None
jvm_heap_max int | None
None
java_gateway_port int | None
None
ecs_max_job_time_min int
required
ecs_memory int
required
ecs_vcpu int
required
ecs_job_definition str
required
ecs_job_queue str
required
ecs_extra_env list[BatchEnvironmentSetting] | None
None

Attributes

task_language: TaskLanguage instance-attribute

general_task_id: Optional[str] = None class-attribute instance-attribute

task_count: int = 0 class-attribute instance-attribute

use_api: bool instance-attribute

java_threads: Optional[int] = None class-attribute instance-attribute

jvm_heap_max: Optional[int] = None class-attribute instance-attribute

java_gateway_port: Optional[int] = None class-attribute instance-attribute

ecs_max_job_time_min: int instance-attribute

ecs_memory: int instance-attribute

ecs_vcpu: int instance-attribute

ecs_job_definition: str instance-attribute

ecs_job_queue: str instance-attribute

ecs_extra_env: Optional[list[BatchEnvironmentSetting]] = None class-attribute instance-attribute