GS2-Script GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| transactionSetting | TransactionSetting | トランザクション設定 | |||
| logSetting | LogSetting | ログの出力設定 |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Script::Namespace
Properties:
Name: namespace1
Description: null
TransactionSetting: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1from 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 Templateclass 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(
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templateimport 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"
)
}
);
}
}
console.log(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(
LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateScript
スクリプト
GS2 では標準の機能だけで機能を実現できない時のためにスクリプトで機能を拡張できるようになっています。
スクリプトは Lua 言語で記述することができます。
スクリプト内から GS2 のサービスのデータを取得することもできますので、柔軟な処理を記述できます。
詳細はドキュメントを参照してください。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | |
| name | string | ✓ | ~ 128文字 | スクリプト名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| script | string | ✓ | ~ 5242880文字 | Luaスクリプト | |
| disableStringNumberToNumber | bool | ✓ | false | 数値のみで構成された文字列を数値に変換しない |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | Script | 作成したスクリプト |
実装例
Type: GS2::Script::Script
Properties:
NamespaceName: namespace1
Name: script-0001
Description: null
Script: result = {permit=true}
DisableStringNumberToNumber: nullfrom 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 Templateclass 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 Templateimport 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}"
);
}
}
console.log(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 TemplateRandomStatus
乱数の状態
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| seed | long | ✓ | ~ 4294967294 | 乱数シード | |
| used | List<RandomUsed> | ~ 1000 items | 使用済み乱数リスト |
RandomUsed
使用済み乱数
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| category | long | ✓ | ~ 4294967294 | カテゴリ | |
| used | long | ✓ | ~ 4294967294 | 使用済み乱数 |
AcquireAction
入手アクション
ConsumeAction
消費アクション
VerifyAction
検証アクション
Transaction
トランザクション
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| transactionId | string | ~ 128文字 | トランザクションID | ||
| verifyActions | List<VerifyAction> | ~ 100 items | 検証アクションのリスト | ||
| consumeActions | List<ConsumeAction> | ~ 100 items | 消費アクションのリスト | ||
| acquireActions | List<AcquireAction> | ~ 100 items | 入手アクションのリスト |
TransactionSetting
トランザクション設定
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | 発行したトランザクションをサーバーサイドで自動的に実行するか | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペース |
| keyId | string | ✓ | “grn:gs2:{region}:{ownerId}:key:default:key:default” | ~ 1024文字 | トランザクションの署名に使用する GS2-Key の暗号鍵 |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペース |
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文字 | タグ名 |
referenceType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| commit_hash | コミットハッシュ |
| branch | ブランチ |
| tag | タグ |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子（Namespace ID）を保持します。
ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。
この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。
GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |