GS2-StateMachine GS2-Deploy/CDK リファレンス

エンティティ

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

	型	必須	値の制限	説明
name	string	✓	~ 32文字	ネームスペース名
description	string		~ 1024文字	説明文
startScript	ScriptSetting			ステートマシンを起動した時に実行するスクリプト
passScript	ScriptSetting			ステートマシンが正常終了した時に実行するスクリプト
errorScript	ScriptSetting			ステートマシンが異常終了した時に実行するスクリプト
lowestStateMachineVersion	long			ステートマシンの最低バージョン
logSetting	LogSetting			ログの出力設定

GetAttr

	型	説明
Item	Namespace	作成したネームスペース

実装例

Type: GS2::StateMachine::Namespace
Properties:
  Name: namespace1
  Description: null
  StartScript: null
  PassScript: null
  ErrorScript: null
  LowestStateMachineVersion: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

from gs2_cdk import Stack, core, state_machine

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        state_machine.Namespace(
            stack=self,
            name="namespace-0001",
            options=state_machine.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\StateMachine\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\StateMachine\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.stateMachine.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.stateMachine.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 stateMachine from "@/gs2cdk/stateMachine";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new stateMachine.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.Gs2StateMachine.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2StateMachine.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

StateMachineMaster

ステートマシン定義

GSLで記述されたステートマシンを管理します。

	型	必須	値の制限	説明
namespaceName	string	✓	~ 32文字	ネームスペース名
mainStateMachineName	string	✓	~ 128文字	メインステートマシン名
payload	string	✓	~ 5242880文字	ステートマシン定義

GetAttr

	型	説明
Item	StateMachineMaster	作成したステートマシンマスター

実装例

Type: GS2::StateMachine::StateMachineMaster
Properties:
  NamespaceName: namespace1
  MainStateMachineName: MainStateMachine
  Payload: \nStateMachine MainStateMachine {\n  EntryPoint Task1;\n\n  Task Task1(int initCounter) {\n    Event Pass();\n    Event Error(string Reason);\n\n    Script grn:gs2:ap-northeast-1:YourOwnerId:script:state-machine-0001:script:Task1\n  }\n\n  PassTask Pass;\n\n  ErrorTask Error(string reason);\n\n  Transition Task1 handling Pass -> Pass;\n  Transition Task1 handling Error -> Error;\n}\n

from gs2_cdk import Stack, core, state_machine

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        state_machine.StateMachineMaster(
            stack=self,
            namespace_name="namespace-0001",
            main_state_machine_name='MainStateMachine',
            payload='\nStateMachine MainStateMachine {\n  EntryPoint Task1;\n\n  Task Task1(int initCounter) {\n    Event Pass();\n    Event Error(string Reason);\n\n    Script grn:gs2:ap-northeast-1:YourOwnerId:script:state-machine-0001:script:Task1\n  }\n\n  PassTask Pass;\n\n  ErrorTask Error(string reason);\n\n  Transition Task1 handling Pass -> Pass;\n  Transition Task1 handling Error -> Error;\n}\n    ',
        )

print(SampleStack().yaml())  # Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\StateMachine\Model\StateMachineMaster(
            stack: $this,
            namespaceName: "namespace-0001",
            mainStateMachineName: "MainStateMachine",
            payload: "\nStateMachine MainStateMachine {\n  EntryPoint Task1;\n\n  Task Task1(int initCounter) {\n    Event Pass();\n    Event Error(string Reason);\n\n    Script grn:gs2:ap-northeast-1:YourOwnerId:script:state-machine-0001:script:Task1\n  }\n\n  PassTask Pass;\n\n  ErrorTask Error(string reason);\n\n  Transition Task1 handling Pass -> Pass;\n  Transition Task1 handling Error -> Error;\n}\n    ",
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.stateMachine.model.StateMachineMaster(
            this,
            "namespace-0001",
            "MainStateMachine",
            "\nStateMachine MainStateMachine {\n  EntryPoint Task1;\n\n  Task Task1(int initCounter) {\n    Event Pass();\n    Event Error(string Reason);\n\n    Script grn:gs2:ap-northeast-1:YourOwnerId:script:state-machine-0001:script:Task1\n  }\n\n  PassTask Pass;\n\n  ErrorTask Error(string reason);\n\n  Transition Task1 handling Pass -> Pass;\n  Transition Task1 handling Error -> Error;\n}\n    "
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

import core from "@/gs2cdk/core";
import stateMachine from "@/gs2cdk/stateMachine";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new stateMachine.model.StateMachineMaster(
            this,
            "namespace-0001",
            "MainStateMachine",
            "\nStateMachine MainStateMachine {\n  EntryPoint Task1;\n\n  Task Task1(int initCounter) {\n    Event Pass();\n    Event Error(string Reason);\n\n    Script grn:gs2:ap-northeast-1:YourOwnerId:script:state-machine-0001:script:Task1\n  }\n\n  PassTask Pass;\n\n  ErrorTask Error(string reason);\n\n  Transition Task1 handling Pass -> Pass;\n  Transition Task1 handling Error -> Error;\n}\n    "
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2StateMachine.Model.StateMachineMaster(
            this,
            "namespace-0001",
            "MainStateMachine",
            "\nStateMachine MainStateMachine {\n  EntryPoint Task1;\n\n  Task Task1(int initCounter) {\n    Event Pass();\n    Event Error(string Reason);\n\n    Script grn:gs2:ap-northeast-1:YourOwnerId:script:state-machine-0001:script:Task1\n  }\n\n  PassTask Pass;\n\n  ErrorTask Error(string reason);\n\n  Transition Task1 handling Pass -> Pass;\n  Transition Task1 handling Error -> Error;\n}\n    "
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

StackEntry

	型	必須	デフォルト	値の制限	説明
stateMachineName	string	✓		~ 128文字	ステートマシン名
taskName	string	✓		~ 128文字	タスク名

Variable

	型	必須	デフォルト	値の制限	説明
stateMachineName	string	✓		~ 128文字	ステートマシン名
value	string	✓		~ 1048576文字	値

LogSetting

	型	必須	デフォルト	値の制限	説明
loggingNamespaceId	string	✓		~ 1024文字	ネームスペースGRN

ScriptSetting

	型	必須	デフォルト	値の制限	説明
triggerScriptId	string			~ 1024文字	スクリプトGRN
doneTriggerTargetType	enum [’none’, ‘gs2_script’, ‘aws’]	✓	“none”	~ 128文字	完了通知の通知先
doneTriggerScriptId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024文字	スクリプトGRN
doneTriggerQueueNamespaceId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024文字	ネームスペースGRN

GS2 States Language 定義拡張

GS2 States Language を CDK で定義するための拡張構文について