GS2-JobQueue¶

Create Client

job_queue_client = client('job-queue')

Method ¶

create_queue ¶

response = job_queue_client:create_queue(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ジョブキューを新規作成します

Request¶

{
  name=string,
  description=string,
  notificationType=string,
  notificationUrl=string,
  notificationGameName=string,
}

name

[string] 名前

description

[string] 説明文

notificationType

[string] ジョブが追加されたときの通知方式

notificationUrl

[string] http/https を選択した際の通知先URL

notificationGameName

[string] gs2-in-game-push-notification を選択した際の GS2-InGamePushNotification のゲーム名

Response¶

item

[Queue] キュー

delete_dead_job ¶

response = job_queue_client:delete_dead_job(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

デッドジョブを削除します。

Request¶

{
  queueName=string,
  userId=string,
  jobId=string,
}

queueName

[string] ジョブキューの名前

userId

[string] ユーザID

jobId

[string] ジョブID

Response¶

None

delete_queue ¶

response = job_queue_client:delete_queue(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ジョブキューを削除します

Request¶

{
  queueName=string,
}

queueName

[string] ジョブキューの名前を指定します。

Response¶

None

describe_dead_job ¶

response = job_queue_client:describe_dead_job(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

デッドジョブの一覧を取得します。

Request¶

{
  queueName=string,
  pageToken=string,
  limit=number,
}

queueName

[string] ジョブキューの名前を指定します。

pageToken

[string] データの取得を開始する位置を指定するトークン

limit

[number] データの取得件数

Response¶

items

[table<DeadJob>] ジョブ

nextPageToken

[string] 次のページを読み込むためのトークン

describe_dead_job_by_script_name ¶

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¶

{
  queueName=string,
  scriptName=string,
  pageToken=string,
  limit=number,
}

queueName

[string] ジョブキューの名前を指定します。

scriptName

[string] スクリプト名

pageToken

[string] データの取得を開始する位置を指定するトークン

limit

[number] データの取得件数

Response¶

items

[table<DeadJob>] ジョブ

nextPageToken

[string] 次のページを読み込むためのトークン

describe_dead_job_by_user_id ¶

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¶

{
  queueName=string,
  userId=string,
  pageToken=string,
  limit=number,
}

queueName

[string] ジョブキューの名前を指定します。

userId

[string] ユーザID

pageToken

[string] データの取得を開始する位置を指定するトークン

limit

[number] データの取得件数

Response¶

items

[table<DeadJob>] ジョブ

nextPageToken

[string] 次のページを読み込むためのトークン

describe_job ¶

response = job_queue_client:describe_job(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ジョブの一覧を取得します。

Request¶

{
  queueName=string,
  pageToken=string,
  limit=number,
}

queueName

[string] ジョブキューの名前を指定します。

pageToken

[string] データの取得を開始する位置を指定するトークン

limit

[number] データの取得件数

Response¶

items

[table<Job>] ジョブ

nextPageToken

[string] 次のページを読み込むためのトークン

describe_job_by_user_id ¶

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¶

{
  queueName=string,
  userId=string,
  pageToken=string,
  limit=number,
}

queueName

[string] ジョブキューの名前を指定します。

userId

[string] ユーザID

pageToken

[string] データの取得を開始する位置を指定するトークン

limit

[number] データの取得件数

Response¶

items

[table<Job>] ジョブ

nextPageToken

[string] 次のページを読み込むためのトークン

describe_job_result ¶

response = job_queue_client:describe_job_result(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ジョブの実行結果の一覧を取得します。

Request¶

{
  queueName=string,
  jobId=string,
  pageToken=string,
  limit=number,
}

queueName

[string] ジョブキューの名前を指定します。

jobId

[string] ジョブID

pageToken

[string] データの取得を開始する位置を指定するトークン

limit

[number] データの取得件数

Response¶

items

[table<JobResult>] ジョブ

nextPageToken

[string] 次のページを読み込むためのトークン

describe_queue ¶

response = job_queue_client:describe_queue(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ジョブキューの一覧を取得します

Request¶

{
  pageToken=string,
  limit=number,
}

pageToken

[string] データの取得を開始する位置を指定するトークン

limit

[number] データの取得件数

Response¶

items

[table<Queue>] キュー

nextPageToken

[string] 次のページを読み込むためのトークン

get_dead_job ¶

response = job_queue_client:get_dead_job(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

デッドジョブを取得します。

Request¶

{
  queueName=string,
  userId=string,
  jobId=string,
}

queueName

[string] ジョブキューの名前

userId

[string] ユーザID

jobId

[string] ジョブID

Response¶

item

[DeadJob] ジョブ

get_queue ¶

response = job_queue_client:get_queue(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ジョブキューを取得します

Request¶

{
  queueName=string,
}

queueName

[string] ジョブキューの名前を指定します。

Response¶

item

[Queue] キュー

push ¶

response = job_queue_client:push(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ジョブキューにジョブを登録します

Request¶

{
  queueName=string,
  userId=string,
  jobs=table<PushJob>,
}

queueName

[string] ジョブキューの名前

userId

[string] ユーザID

jobs

[table<PushJob>] 追加するジョブの情報

Response¶

items

[table<Job>] ジョブ

run ¶

response = job_queue_client:run(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ジョブキューを実行します

Request¶

{
  queueName=string,
  accessToken=string
}

queueName

[string] ジョブキューの名前

accessToken

[string] GS2-Auth で発行を受けたアクセストークン

Response¶

item

[JobResult] ジョブ

run_by_user_id ¶

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¶

{
  queueName=string,
  userId=string,
}

queueName

[string] ジョブキューの名前

userId

[string] ユーザID

Response¶

item

[JobResult] ジョブ

update_queue ¶

response = job_queue_client:update_queue(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ジョブキューを更新します

Request¶

{
  queueName=string,
  description=string,
  notificationType=string,
  notificationUrl=string,
  notificationGameName=string,
}

queueName

[string] ジョブキューの名前を指定します。

description

[string] 説明文

notificationType

[string] ジョブが追加されたときの通知方式

notificationUrl

[string] http/https を選択した際の通知先URL

notificationGameName

[string] gs2-in-game-push-notification を選択した際の GS2-InGamePushNotification のゲーム名

Response¶

item

[Queue] キュー

Model ¶

Queue ¶

queueId

[string] キューGRN

ownerId

[string] オーナーID

name

[string] 名前

description

[string] 説明文

notificationType

[string] ジョブが追加されたときの通知方式

notificationUrl

[string] http/https を選択した際の通知先URL

notificationGameName

[string] gs2-in-game-push-notification を選択した際の GS2-InGamePushNotification のゲーム名

createAt

[number] 作成日時(エポック秒)

updateAt

[number] 最終更新日時(エポック秒)

Job ¶

jobId

[string] ジョブID

queueId

[string] キューGRN

userId

[string] オーナーID

scriptName

[string] スクリプト名

args

[string] 引数

currentRetry

[number] 現在のリトライ回数

maxRetry

[number] 最大リトライ回数

createAt

[number] 作成日時

DeadJob ¶

jobId

[string] ジョブID

queueId

[string] キューGRN

userId

[string] オーナーID

scriptName

[string] スクリプト名

args

[string] 引数

createAt

[number] 作成日時

JobResult ¶

jobId

[string] ジョブID

queueId

[string] キューGRN

statusCode

[number] ステータスコード

result

[string] 実行結果

endOfJob

[boolean] キューの中で最後のジョブだったか

createAt

[number] 作成日時

PushJob ¶

scriptName

[string] スクリプト名

args

[string] 引数

maxRetry

[number] 最大リトライ回数