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

エンティティ

Namespace

ネームスペース

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

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

	型	必須	値の制限	説明
name	string	✓	~ 32文字	ネームスペース名
description	string		~ 1024文字	説明文
logSetting	LogSetting			ログの出力設定

GetAttr

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

実装例

Type: GS2::Script::Namespace
Properties:
  Name: namespace1
  Description: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

from gs2_cdk import Stack, core, script

class SampleStack(Stack):

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new script.model.Namespace(
            this,
            "namespace-0001",
            {
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Script.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2Script.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

Script

スクリプト

GS2 では標準の機能だけで機能を実現できない時のためにスクリプトで機能を拡張できるようになっています。スクリプトは Lua 言語で記述することができます。

スクリプト内から GS2 のサービスのデータを取得することもできますので、柔軟な処理を記述できます。詳細はドキュメントを参照してください。

	型	必須	値の制限	説明
namespaceName	string	✓	~ 32文字	ネームスペース名
name	string	✓	~ 128文字	スクリプト名
description	string		~ 1024文字	説明文
script	string	✓	~ 5242880文字	Luaスクリプト

GetAttr

	型	説明
Item	Script	作成したスクリプト

実装例

Type: GS2::Script::Script
Properties:
  NamespaceName: namespace1
  Name: script-0001
  Description: null
  Script: result = {permit=true}

from gs2_cdk import Stack, core, script

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        script.Script(
            stack=self,
            namespace_name="namespace-0001",
            name='script-0001',
            script='result = {permit=true}',
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Script\Model\Script(
            stack: $this,
            namespaceName: "namespace-0001",
            name: "script-0001",
            script: "result = {permit=true}",
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.script.model.Script(
            this,
            "namespace-0001",
            "script-0001",
            "result = {permit=true}"
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new script.model.Script(
            this,
            "namespace-0001",
            "script-0001",
            "result = {permit=true}"
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Script.Model.Script(
            this,
            "namespace-0001",
            "script-0001",
            "result = {permit=true}"
        );
    }
}

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

GitHubCheckoutSetting

	型	必須	値の制限	説明
apiKeyId	string	✓	~ 1024文字	GitHub のAPIキーGRN
repositoryName	string	✓	~ 1024文字	リポジトリ名
sourcePath	string	✓	~ 1024文字	ソースコードのファイルパス
referenceType	enum [‘commit_hash’, ‘branch’, ’tag’]	✓	~ 128文字	コードの取得元
commitHash	string	{referenceType} == “commit_hash”	~ 1024文字	コミットハッシュ
branchName	string	{referenceType} == “branch”	~ 1024文字	ブランチ名
tagName	string	{referenceType} == “tag”	~ 1024文字	タグ名

LogSetting

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