GS2-Deploy/CDK Reference of GS2-Limit

Entities

Namespace

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.

TypeRequireDefaultLimitationDescription
namestring~ 32 charsNamespace name
descriptionstring~ 1024 charsDescription
logSettingLogSettingLog output settings

GetAttr

TypeDescription
ItemNamespaceNamespace 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(
                        "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

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.

Please refer to the documentation for the format of the JSON file.

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 32 charsNamespace name
settingsstring~ 5242880 charsMaster data

GetAttr

TypeDescription
ItemCurrentLimitMasterUpdated, currently available limit settings

Implementation Example

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,
            # omission
        ).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,
            // omission
        ))->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,
            // 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.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,
            // omission
        ).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

TypeRequireDefaultLimitationDescription
apiKeyIdstring~ 1024 charsGitHub API key GRN
repositoryNamestring~ 1024 charsRepository Name
sourcePathstring~ 1024 charsSource code file path
referenceTypeenum [
“commit_hash”,
“branch”,
“tag”
]
~ 128 charsSource of code
commitHashstring{referenceType} == “commit_hash”~ 1024 charsCommit hash
branchNamestring{referenceType} == “branch”~ 1024 charsBranch Name
tagNamestring{referenceType} == “tag”~ 1024 charsTag Name

LogSetting

TypeRequireDefaultLimitationDescription
loggingNamespaceIdstring~ 1024 charsNamespace GRN