==================================================== GS2-JobQueue ==================================================== **Create Client** .. code-block:: lua job_queue_client = client('job-queue') .. contents:: 目次 :local: :depth: 2 Method ==================================================== ---------------------------------------------------- create_queue ---------------------------------------------------- .. code-block:: lua response = job_queue_client:create_queue(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブキューを新規作成します Request ---------------------------------------------------- .. include:: control/CreateQueueRequest.rst Response ---------------------------------------------------- .. include:: control/CreateQueueResult.rst ---------------------------------------------------- delete_dead_job ---------------------------------------------------- .. code-block:: lua response = job_queue_client:delete_dead_job(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end デッドジョブを削除します。 Request ---------------------------------------------------- .. include:: control/DeleteDeadJobRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- delete_queue ---------------------------------------------------- .. code-block:: lua response = job_queue_client:delete_queue(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブキューを削除します Request ---------------------------------------------------- .. include:: control/DeleteQueueRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- describe_dead_job ---------------------------------------------------- .. code-block:: lua response = job_queue_client:describe_dead_job(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end デッドジョブの一覧を取得します。 Request ---------------------------------------------------- .. include:: control/DescribeDeadJobRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeDeadJobResult.rst ---------------------------------------------------- describe_dead_job_by_script_name ---------------------------------------------------- .. code-block:: lua response = job_queue_client:describe_dead_job_by_script_name(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end スクリプト名で絞り込んでデッドジョブの一覧を取得します。 Request ---------------------------------------------------- .. include:: control/DescribeDeadJobByScriptNameRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeDeadJobByScriptNameResult.rst ---------------------------------------------------- describe_dead_job_by_user_id ---------------------------------------------------- .. code-block:: lua response = job_queue_client:describe_dead_job_by_user_id(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ユーザIDで絞り込んでデッドジョブの一覧を取得します。 Request ---------------------------------------------------- .. include:: control/DescribeDeadJobByUserIdRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeDeadJobByUserIdResult.rst ---------------------------------------------------- describe_job ---------------------------------------------------- .. code-block:: lua response = job_queue_client:describe_job(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブの一覧を取得します。 Request ---------------------------------------------------- .. include:: control/DescribeJobRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeJobResult.rst ---------------------------------------------------- describe_job_by_user_id ---------------------------------------------------- .. code-block:: lua response = job_queue_client:describe_job_by_user_id(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブの一覧を取得します。 Request ---------------------------------------------------- .. include:: control/DescribeJobByUserIdRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeJobByUserIdResult.rst ---------------------------------------------------- describe_job_result ---------------------------------------------------- .. code-block:: lua response = job_queue_client:describe_job_result(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブの実行結果の一覧を取得します。 Request ---------------------------------------------------- .. include:: control/DescribeJobResultRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeJobResultResult.rst ---------------------------------------------------- describe_queue ---------------------------------------------------- .. code-block:: lua response = job_queue_client:describe_queue(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブキューの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeQueueRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeQueueResult.rst ---------------------------------------------------- get_dead_job ---------------------------------------------------- .. code-block:: lua response = job_queue_client:get_dead_job(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end デッドジョブを取得します。 Request ---------------------------------------------------- .. include:: control/GetDeadJobRequest.rst Response ---------------------------------------------------- .. include:: control/GetDeadJobResult.rst ---------------------------------------------------- get_queue ---------------------------------------------------- .. code-block:: lua response = job_queue_client:get_queue(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブキューを取得します Request ---------------------------------------------------- .. include:: control/GetQueueRequest.rst Response ---------------------------------------------------- .. include:: control/GetQueueResult.rst ---------------------------------------------------- push ---------------------------------------------------- .. code-block:: lua response = job_queue_client:push(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブキューにジョブを登録します Request ---------------------------------------------------- .. include:: control/PushRequest.rst Response ---------------------------------------------------- .. include:: control/PushResult.rst ---------------------------------------------------- run ---------------------------------------------------- .. code-block:: lua response = job_queue_client:run(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブキューを実行します Request ---------------------------------------------------- .. include:: control/RunRequest.rst Response ---------------------------------------------------- .. include:: control/RunResult.rst ---------------------------------------------------- run_by_user_id ---------------------------------------------------- .. code-block:: lua response = job_queue_client:run_by_user_id(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブキューを実行します Request ---------------------------------------------------- .. include:: control/RunByUserIdRequest.rst Response ---------------------------------------------------- .. include:: control/RunByUserIdResult.rst ---------------------------------------------------- update_queue ---------------------------------------------------- .. code-block:: lua response = job_queue_client:update_queue(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ジョブキューを更新します Request ---------------------------------------------------- .. include:: control/UpdateQueueRequest.rst Response ---------------------------------------------------- .. include:: control/UpdateQueueResult.rst Model ==================================================== ---------------------------------------------------- Queue ---------------------------------------------------- .. include:: model/Queue.rst ---------------------------------------------------- Job ---------------------------------------------------- .. include:: model/Job.rst ---------------------------------------------------- DeadJob ---------------------------------------------------- .. include:: model/DeadJob.rst ---------------------------------------------------- JobResult ---------------------------------------------------- .. include:: model/JobResult.rst ---------------------------------------------------- PushJob ---------------------------------------------------- .. include:: model/PushJob.rst