GS2-JobQueue GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
name | string | ✓ | | ~ 32文字 | ネームスペース名 |
description | string | | | ~ 1024文字 | 説明文 |
enableAutoRun | bool | ✓ | false | | 登録されたジョブをサーバーサイドで自動的に実行するか |
pushNotification | NotificationSetting | !{enableAutoRun} | | | ジョブキューにジョブが登録されたときののプッシュ通知 |
runNotification | NotificationSetting | {enableAutoRun} | | | ジョブキューのジョブが実行されたときののプッシュ通知 |
logSetting | LogSetting | | | | ログの出力設定 |
GetAttr
実装例
Type: GS2::JobQueue::Namespace
Properties:
Name: namespace1
Description: null
EnableAutoRun: null
PushNotification: null
RunNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, job_queue
class SampleStack(Stack):
def __init__(self):
super().__init__()
job_queue.Namespace(
stack=self,
name="namespace-0001",
options=job_queue.NamespaceOptions(
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\JobQueue\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\JobQueue\Model\Options\NamespaceOptions(
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
),
),
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.jobQueue.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.jobQueue.model.options.NamespaceOptions() {
{
logSetting = new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import jobQueue from "@/gs2cdk/jobQueue";
class SampleStack extends core.Stack
{
public constructor() {
super();
new jobQueue.model.Namespace(
this,
"namespace-0001",
{
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2JobQueue.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2JobQueue.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
NotificationSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
gatewayNamespaceId | string | ✓ | | ~ 1024文字 | ネームスペースGRN |
enableTransferMobileNotification | bool? | | | | モバイルプッシュ通知へ転送するか |
sound | string | | | ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名 |
LogSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
loggingNamespaceId | string | ✓ | | ~ 1024文字 | ネームスペースGRN |
JobEntry
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
scriptId | string | ✓ | | ~ 1024文字 | スクリプトGRN |
args | string | ✓ | “{}” | ~ 131072文字 | 引数 |
maxTryCount | int | ✓ | 3 | ~ 100 | 最大試行回数 |
JobResultBody
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
tryNumber | int | ✓ | | 1 ~ 10000 | 試行回数 |
statusCode | int | ✓ | | ~ 1000 | ステータスコード |
result | string | ✓ | | ~ 5242880文字 | レスポンスの内容 |
tryAt | long | ✓ | | | 作成日時 |