Transaction Action of GS2-JobQueue

Specification of verify/consume/acquire transaction actions

ConsumeAction

Gs2JobQueue:DeleteJobByUserId

Delete job by specifying a user ID

Whether the action allows quantity specification: NO

Whether the action is reversible: NO

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
jobName	string	✓	UUID	~ 36 chars	Job Name Maintains a unique name for each job. The name is automatically generated in UUID (Universally Unique Identifier) format and used to identify each job.
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2JobQueue:DeleteJobByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "jobName": "[string]Job Name",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2JobQueue:DeleteJobByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  jobName: "[string]Job Name"
  timeOffsetToken: "[string]Time offset token"

transaction.service("jobQueue").consume.delete_job_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    jobName="[string]Job Name",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2JobQueue:PushByUserId

Push jobs by specifying a user ID

Whether the action allows quantity specification: NO

Whether the action is reversible: NO

	Type	Required	Value Limits	Description
namespaceName	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓	~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
jobs	List<JobEntry>		0 ~ 10 items	List of Jobs
timeOffsetToken	string		~ 1024 chars	Time offset token

{
    "action": "Gs2JobQueue:PushByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "jobs": [
            {
                "scriptId": "[string]Script GRN",
                "args": "[string]argument",
                "maxTryCount": "[int]Maximum number of attempts"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2JobQueue:PushByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  jobs: 
    - scriptId: "[string]Script GRN"
      args: "[string]argument"
      maxTryCount: "[int]Maximum number of attempts"
  timeOffsetToken: "[string]Time offset token"

transaction.service("jobQueue").acquire.push_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    jobs={
        {
            scriptId="[string]Script GRN",
            args="[string]argument",
            maxTryCount="[int]Maximum number of attempts"
        }
    },
    timeOffsetToken="[string]Time offset token",
})