GS2-JobQueue トランザクションアクション

検証/消費/入手の各トランザクションアクションの仕様

ConsumeAction

消費アクション

Gs2JobQueue:DeleteJobByUserId

ユーザーIDを指定してジョブを削除

数量指定可能なアクション：いいえ

反転可能なアクション：いいえ

	型	必須	デフォルト	値の制限	説明
namespaceName	string	✓		~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userId	string	✓		~ 128文字	ユーザーID `#{userId}` と設定することでログイン中のユーザーIDに置換されます。
jobName	string	✓	UUID	~ 36文字	ジョブの名前ジョブの一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各ジョブを識別するために使用されます。
timeOffsetToken	string			~ 1024文字	タイムオフセットトークン

{
    "action": "Gs2JobQueue:DeleteJobByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "jobName": "[string]ジョブの名前",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2JobQueue:DeleteJobByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  jobName: "[string]ジョブの名前"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("jobQueue").consume.delete_job_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    jobName="[string]ジョブの名前",
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

入手アクション

Gs2JobQueue:PushByUserId

ユーザーIDを指定してジョブを登録

数量指定可能なアクション：いいえ

反転可能なアクション：いいえ

	型	必須	値の制限	説明
namespaceName	string	✓	~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userId	string	✓	~ 128文字	ユーザーID `#{userId}` と設定することでログイン中のユーザーIDに置換されます。
jobs	List<JobEntry>		0 ~ 10 items	追加するジョブの一覧
timeOffsetToken	string		~ 1024文字	タイムオフセットトークン

{
    "action": "Gs2JobQueue:PushByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "jobs": [
            {
                "scriptId": "[string]スクリプトGRN",
                "args": "[string]引数",
                "maxTryCount": "[int]最大試行回数"
            }
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2JobQueue:PushByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  jobs: 
    - scriptId: "[string]スクリプトGRN"
      args: "[string]引数"
      maxTryCount: "[int]最大試行回数"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("jobQueue").acquire.push_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    jobs={
        {
            scriptId="[string]スクリプトGRN",
            args="[string]引数",
            maxTryCount="[int]最大試行回数"
        }
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})