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

エンティティ

Namespace

ネームスペース

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

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

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

GetAttr

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

実装例

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

from gs2_cdk import Stack, core, limit

class SampleStack(Stack):

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

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

CurrentLimitMaster

現在有効なマスターデータ

GS2ではマスターデータの管理にJSON形式のファイルを使用します。ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますがよりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

JSONファイルの形式についてはドキュメントを参照ください。

	型	必須	デフォルト	値の制限	説明
namespaceName	string	✓		~ 32文字	ネームスペース名
settings	string	✓		~ 5242880文字	マスターデータ

GetAttr

	型	説明
Item	CurrentLimitMaster	更新した現在有効な回数制限設定

実装例

Type: GS2::Limit::CurrentLimitMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-04-05",
    "limitModels": [
      {
        "name": "daily",
        "metadata": "DAILY",
        "resetType": "daily",
        "resetHour": 9
      },
      {
        "name": "weekly",
        "metadata": "WEEKLY",
        "resetType": "weekly",
        "resetDayOfWeek": "sunday",
        "resetHour": 18
      }
    ]
  }

from gs2_cdk import Stack, core, limit

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        limit.Namespace(
            stack=self,
            # 省略
        ).master_data(
            [
                limit.LimitModel(
                    name='daily',
                    reset_type='daily',
                    options=limit.LimitModelOptions(
                        metadata='DAILY',
                        reset_hour=9,
                    ),
                ),
                limit.LimitModel(
                    name='weekly',
                    reset_type='weekly',
                    options=limit.LimitModelOptions(
                        metadata='WEEKLY',
                        reset_day_of_week='sunday',
                        reset_hour=18,
                    ),
                ),
            ],
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Limit\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"daily",
                    resetType: \Gs2Cdk\Limit\Model\Enums\CurrentLimitMasterResetType::DAILY
                    options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
                        metadata:"DAILY",
                        resetHour:9,
                    ),
                ),
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"weekly",
                    resetType: \Gs2Cdk\Limit\Model\Enums\CurrentLimitMasterResetType::WEEKLY
                    options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
                        metadata:"WEEKLY",
                        resetDayOfWeek:"sunday",
                        resetHour:18,
                    ),
                ),
            ],
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.limit.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.limit.model.LimitModel(
                    "daily",
                    Daily,
                    new io.gs2.cdk.limit.model.options.LimitModelOptions() {
                        {
                            metadata: "DAILY";
                            resetHour: 9;
                        }
                    }
                ),
                new io.gs2.cdk.limit.model.LimitModel(
                    "weekly",
                    Weekly,
                    new io.gs2.cdk.limit.model.options.LimitModelOptions() {
                        {
                            metadata: "WEEKLY";
                            resetDayOfWeek: "sunday";
                            resetHour: 18;
                        }
                    }
                )
            )
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new limit.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new limit.model.LimitModel(
                    "daily",
                    limit.model.CurrentLimitMasterResetType.DAILY,
                    {
                        metadata: "DAILY",
                        resetHour: 9
                    }
                ),
                new limit.model.LimitModel(
                    "weekly",
                    limit.model.CurrentLimitMasterResetType.WEEKLY,
                    {
                        metadata: "WEEKLY",
                        resetDayOfWeek: "sunday",
                        resetHour: 18
                    }
                )
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Limit.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    "daily",
                    Gs2Cdk.Gs2Limit.Model.Enums.CurrentLimitMasterResetType.Daily,
                    new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions {
                        metadata = "DAILY",
                        resetHour = 9,
                    }
                ),
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    "weekly",
                    Gs2Cdk.Gs2Limit.Model.Enums.CurrentLimitMasterResetType.Weekly,
                    new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions {
                        metadata = "WEEKLY",
                        resetDayOfWeek = "sunday",
                        resetHour = 18,
                    }
                )
            }
        );
    }
}

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

GitHubCheckoutSetting

GitHubからマスターデータをチェックアウトする設定

	型	必須	値の制限	説明
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

ログの書き出し設定

ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子（Namespace ID）を保持します。ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

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