GS2-Deploy/CDK Reference of GS2-Limit

Entities

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

	Type	Require	Limitation	Description
name	string	✓	~ 128 chars	Namespace name
description	string		~ 1024 chars	Description
logSetting	LogSetting			Log output settings

GetAttr

	Type	Description
Item	Namespace	Namespace created

Implementation Example

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(
                        loggingNamespaceId = "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(
                    LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

CurrentLimitMaster

Currently available master data

GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.

We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.

Note

Please refer to Master Data Reference of GS2-Limit for the JSON file format.

	Type	Require	Default	Limitation	Description
namespaceName	string	✓		~ 128 chars	Namespace name
settings	string	✓		~ 5242880 chars	Master data

GetAttr

	Type	Description
Item	CurrentLimitMaster	Updated, currently available limit settings

Implementation Example

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

from gs2_cdk import Stack, core, limit

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        limit.Namespace(
            stack=self,
            # omission
        ).master_data(
            limit_models=[
                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,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"daily",
                    resetType: \Gs2Cdk\Limit\Model\Enums\LimitModelResetType::DAILY,
                    options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
                        metadata:"DAILY",
                        resetHour:9
                    )
                ),
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"weekly",
                    resetType: \Gs2Cdk\Limit\Model\Enums\LimitModelResetType::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,
            // omission
        ).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,
            // omission
        ).masterData(
            [
                new limit.model.LimitModel(
                    "daily",
                    limit.model.LimitModelResetType.DAILY,
                    {
                        metadata: "DAILY",
                        resetHour: 9
                    }
                ),
                new limit.model.LimitModel(
                    "weekly",
                    limit.model.LimitModelResetType.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,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    "daily",
                    Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetType.Daily,
                    new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions {
                        metadata = "DAILY",
                        resetHour = 9
                    }
                ),
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    "weekly",
                    Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetType.Weekly,
                    new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions {
                        metadata = "WEEKLY",
                        resetDayOfWeek = "sunday",
                        resetHour = 18
                    }
                )
            }
        );
    }
}

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

GitHubCheckoutSetting

Setup to check out master data from GitHub

	Type	Require	Limitation	Description
apiKeyId	string	✓	~ 1024 chars	GitHub API key GRN
repositoryName	string	✓	~ 1024 chars	Repository Name
sourcePath	string	✓	~ 1024 chars	Source code file path
referenceType	enum { “commit_hash”, “branch”, “tag” }	✓	~ 128 chars	Source of code
commitHash	string	{referenceType} == “commit_hash”	~ 1024 chars	Commit hash
branchName	string	{referenceType} == “branch”	~ 1024 chars	Branch Name
tagName	string	{referenceType} == “tag”	~ 1024 chars	Tag Name

Enumeration type definition to specify as referenceType

Enumerator String Definition	Description
commit_hash	Commit hash
branch	Branch
tag	Tag

LogSetting

Log setting

This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.

	Type	Require	Default	Limitation	Description
loggingNamespaceId	string	✓		~ 1024 chars	Namespace GRN