genvid.toolbox.JobsAPI

class genvid.toolbox.JobsAPI(parent_api: BaseHttpApiTool, **kwargs)

ベースクラス: BaseHttpApiTool

ジョブ API。 Bastion APICluster API を参照してください。

バージョン 1.12.0 で追加.

NAME = 'logs-api'

このツールのロガー名。子 class (children) で再定義する必要があります。

get_base_url(timeout=0.0) str

ベース URL を取得する。

get_job_definitions(timeout=0.0) dict

すべてのジョブの定義のリストを取得する。

パラメータ

timeout -- タイムアウト (秒)。

バージョン 1.12.0 で追加.

update_job_definitions(jobs: dict, timeout=0.0) dict

ジョブの定義を作成または更新する。

パラメータ
  • jobs -- ジョブの定義。

  • timeout -- タイムアウト (秒)。

バージョン 1.12.0 で追加.

get_job_definition(job_id: str, timeout=0.0) dict

ジョブの定義を取得する。

パラメータ
  • job_id -- ジョブ ID。

  • timeout -- タイムアウト (秒)。

バージョン 1.12.0 で追加.

add_job_definition(job_id: str, job: dict, timeout=0.0) dict

ジョブの定義を作成する。

パラメータ
  • job_id -- ジョブ ID。

  • job -- ジョブの定義。

  • timeout -- タイムアウト (秒)。

バージョン 1.12.0 で追加.

update_job_definition(job_id: str, job: dict, timeout=0.0) dict

ジョブの定義を更新する。

パラメータ
  • job_id -- ジョブ ID。

  • job -- ジョブの定義。

  • timeout -- タイムアウト (秒)。

バージョン 1.12.0 で追加.

delete_job_definitions(timeout=0.0) dict

すべてのジョブの定義を削除する。

パラメータ

timeout -- タイムアウト (秒)。

バージョン 1.12.0 で追加.

delete_job_definition(job_id: str, timeout=0.0) dict

ジョブの定義を削除する。

パラメータ
  • job_id -- ジョブ ID。

  • timeout -- タイムアウト (秒)。

バージョン 1.12.0 で追加.

get_jobs_summary(timeout=0.0) List[dict]

すべてのジョブの概要を取得する。

パラメータ

timeout -- タイムアウト (秒)。

get_job_summary(job_id: str, timeout=0.0) List[dict]

ジョブの概要を取得する

パラメータ
  • job_id -- ジョブ ID。

  • timeout -- タイムアウト (秒)。

start_job(job_id: str, timeout=0.0) List[dict]

ジョブを開始する

パラメータ
  • job_id -- ジョブ ID。

  • timeout -- タイムアウト (秒)。

stop_job(job_id: str, timeout=0.0) List[dict]

ジョブを停止する

パラメータ
  • job_id -- ジョブ ID。

  • timeout -- タイムアウト (秒)。

start_all_job(timeout=0.0) List[dict]

すべてのジョブを開始する。

パラメータ

timeout -- タイムアウト (秒)。

stop_all_job(timeout=0.0) List[dict]

すべてのジョブを停止する

パラメータ

timeout -- タイムアウト (秒)。

update_job_count(job_id: str, task_group: str, count: int, timeout=0.0) List[dict]

増減値によりタスクグループ数を更新する

パラメータ
  • job_id -- ジョブ ID

  • task_group -- タスクグループ。

  • count -- タスクグループ数のデルタ。0 でジョブを停止します。

  • timeout -- タイムアウト (秒)。

get_taskgroup_count(job_id: str, task_group: str, timeout=0.0) int

タスクグループ数を取得します

パラメータ
  • job_id -- ジョブ ID

  • task_group -- タスクグループ。

  • timeout -- タイムアウト (秒)。

バージョン 1.23.0 で追加.

set_taskgroup_count(job_id: str, task_group: str, count: int, timeout=0.0) List[dict]

タスクグループ数を設定します

パラメータ
  • job_id -- ジョブ ID

  • task_group -- タスクグループ。

  • count -- タスクグループ数のデルタ。0 でジョブを停止します。

  • timeout -- タイムアウト (秒)。

バージョン 1.23.0 で追加.

class api_jobs.JobsAPI

genvid.toolbox.JobsAPI の実装