GS2-Buff GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| applyBuffScript | ScriptSetting | バフを適用する際に実行するスクリプト | |||
| logSetting | LogSetting | ログの出力設定 |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Buff::Namespace
Properties:
Name: namespace1
Description: null
ApplyBuffScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1from gs2_cdk import Stack, core, buff
class SampleStack(Stack):
def __init__(self):
super().__init__()
buff.Namespace(
stack=self,
name="namespace-0001",
options=buff.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\Buff\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Buff\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.buff.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.buff.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 buff from "@/gs2cdk/buff";
class SampleStack extends core.Stack
{
public constructor() {
super();
new buff.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.Gs2Buff.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Buff.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 TemplateCurrentBuffMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
Note
JSONファイルの形式については GS2-Buff マスターデータリファレンス をご参照ください。| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | |
| settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | CurrentBuffMaster | 更新した現在有効なバフ設定 |
実装例
Type: GS2::Buff::CurrentBuffMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2024-04-15",
"buffEntryModels": [
{
"name": "buff-0001",
"expression": "rate_add",
"targetType": "model",
"priority": 1,
"metadata": "BUFF_0001",
"targetModel":
{
"targetModelName": "Gs2Experience:Status",
"targetFieldName": "rankCapValue",
"conditionGrns": [
{
"targetModelName": "Gs2Experience:ExperienceModel",
"targetGrn": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
},
{
"targetServiceName": "Gs2Experience:ExperienceModel",
"targetModelName": "rateModel",
"targetGrn": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002"
}
],
"rate": 1.0
}
},
{
"name": "buff-0002",
"expression": "mul",
"targetType": "action",
"priority": 2,
"metadata": "BUFF_0002",
"targetAction":
{
"targetActionName": "Gs2Experience:AddExperienceByUserId",
"targetFieldName": "experienceValue",
"conditionGrns": [
{
"targetModelName": "Gs2Experience:ExperienceModel",
"targetGrn": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
}
],
"rate": 2.0
}
},
{
"name": "buff-0002",
"expression": "mul",
"targetType": "model",
"priority": 3,
"metadata": "BUFF_0002",
"targetModel":
{
"targetModelName": "Gs2Experience:Status",
"targetFieldName": "rankCapValue",
"conditionGrns": [
{
"targetModelName": "Gs2Experience:ExperienceModel",
"targetGrn": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
}
],
"rate": 3.0
}
}
]
}from gs2_cdk import Stack, core, buff
class SampleStack(Stack):
def __init__(self):
super().__init__()
buff.Namespace(
stack=self,
# 省略
).master_data(
buff_entry_models=[
buff.BuffEntryModel(
name='buff-0001',
expression='rate_add',
target_type='model',
priority=1,
options=buff.BuffEntryModelOptions(
metadata='BUFF_0001',
target_model=buff.BuffTargetModel(
target_model_name='Gs2Experience:Status',
target_field_name='rankCapValue',
condition_grns=[
buff.BuffTargetGrn(
target_model_name='Gs2Experience:ExperienceModel',
target_grn='grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'
),
buff.BuffTargetGrn(
target_service_name='Gs2Experience:ExperienceModel',
target_model_name='rateModel',
target_grn='grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002'
)
],
rate=1.0
),
),
),
buff.BuffEntryModel(
name='buff-0002',
expression='mul',
target_type='action',
priority=2,
options=buff.BuffEntryModelOptions(
metadata='BUFF_0002',
target_action=buff.BuffTargetAction(
target_action_name='Gs2Experience:AddExperienceByUserId',
target_field_name='experienceValue',
condition_grns=[
buff.BuffTargetGrn(
target_model_name='Gs2Experience:ExperienceModel',
target_grn='grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'
)
],
rate=2.0
),
),
),
buff.BuffEntryModel(
name='buff-0002',
expression='mul',
target_type='model',
priority=3,
options=buff.BuffEntryModelOptions(
metadata='BUFF_0002',
target_model=buff.BuffTargetModel(
target_model_name='Gs2Experience:Status',
target_field_name='rankCapValue',
condition_grns=[
buff.BuffTargetGrn(
target_model_name='Gs2Experience:ExperienceModel',
target_grn='grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'
)
],
rate=3.0
),
),
),
],
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Buff\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Buff\Model\BuffEntryModel(
name:"buff-0001",
expression: \Gs2Cdk\Buff\Model\Enums\BuffEntryModelExpression::RATE_ADD,
targetType: \Gs2Cdk\Buff\Model\Enums\BuffEntryModelTargetType::MODEL,
priority:1,
options: new \Gs2Cdk\Buff\Model\Options\BuffEntryModelOptions(
metadata:"BUFF_0001",
targetModel:new \Gs2Cdk\Buff\Model\BuffTargetModel(
targetModelName: "Gs2Experience:Status",
targetFieldName: "rankCapValue",
conditionGrns: [
new \Gs2Cdk\Buff\Model\BuffTargetGrn(
targetModelName: "Gs2Experience:ExperienceModel",
targetGrn: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
),
new \Gs2Cdk\Buff\Model\BuffTargetGrn(
targetServiceName: "Gs2Experience:ExperienceModel",
targetModelName: "rateModel",
targetGrn: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002"
)
],
rate: 1.0
)
)
),
new \Gs2Cdk\Buff\Model\BuffEntryModel(
name:"buff-0002",
expression: \Gs2Cdk\Buff\Model\Enums\BuffEntryModelExpression::MUL,
targetType: \Gs2Cdk\Buff\Model\Enums\BuffEntryModelTargetType::ACTION,
priority:2,
options: new \Gs2Cdk\Buff\Model\Options\BuffEntryModelOptions(
metadata:"BUFF_0002",
targetAction:new \Gs2Cdk\Buff\Model\BuffTargetAction(
targetActionName: "Gs2Experience:AddExperienceByUserId",
targetFieldName: "experienceValue",
conditionGrns: [
new \Gs2Cdk\Buff\Model\BuffTargetGrn(
targetModelName: "Gs2Experience:ExperienceModel",
targetGrn: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
)
],
rate: 2.0
)
)
),
new \Gs2Cdk\Buff\Model\BuffEntryModel(
name:"buff-0002",
expression: \Gs2Cdk\Buff\Model\Enums\BuffEntryModelExpression::MUL,
targetType: \Gs2Cdk\Buff\Model\Enums\BuffEntryModelTargetType::MODEL,
priority:3,
options: new \Gs2Cdk\Buff\Model\Options\BuffEntryModelOptions(
metadata:"BUFF_0002",
targetModel:new \Gs2Cdk\Buff\Model\BuffTargetModel(
targetModelName: "Gs2Experience:Status",
targetFieldName: "rankCapValue",
conditionGrns: [
new \Gs2Cdk\Buff\Model\BuffTargetGrn(
targetModelName: "Gs2Experience:ExperienceModel",
targetGrn: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
)
],
rate: 3.0
)
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.buff.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.buff.model.BuffEntryModel(
"buff-0001",
RateAdd,
Model,
1,
new io.gs2.cdk.buff.model.options.BuffEntryModelOptions() {
{
metadata: "BUFF_0001";
targetModel: new io.gs2.cdk.buff.model.BuffTargetModel(
"Gs2Experience:Status",
"rankCapValue",
Arrays.asList(
new io.gs2.cdk.buff.model.BuffTargetGrn(
"Gs2Experience:ExperienceModel",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
),
new io.gs2.cdk.buff.model.BuffTargetGrn(
"Gs2Experience:ExperienceModel",
"rateModel",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002"
)
)
1.0f
);
}
}
),
new io.gs2.cdk.buff.model.BuffEntryModel(
"buff-0002",
Mul,
Action,
2,
new io.gs2.cdk.buff.model.options.BuffEntryModelOptions() {
{
metadata: "BUFF_0002";
targetAction: new io.gs2.cdk.buff.model.BuffTargetAction(
"Gs2Experience:AddExperienceByUserId",
"experienceValue",
Arrays.asList(
new io.gs2.cdk.buff.model.BuffTargetGrn(
"Gs2Experience:ExperienceModel",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
)
)
2.0f
);
}
}
),
new io.gs2.cdk.buff.model.BuffEntryModel(
"buff-0002",
Mul,
Model,
3,
new io.gs2.cdk.buff.model.options.BuffEntryModelOptions() {
{
metadata: "BUFF_0002";
targetModel: new io.gs2.cdk.buff.model.BuffTargetModel(
"Gs2Experience:Status",
"rankCapValue",
Arrays.asList(
new io.gs2.cdk.buff.model.BuffTargetGrn(
"Gs2Experience:ExperienceModel",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
)
)
3.0f
);
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import buff from "@/gs2cdk/buff";
class SampleStack extends core.Stack
{
public constructor() {
super();
new buff.model.Namespace(
this,
// 省略
).masterData(
[
new buff.model.BuffEntryModel(
"buff-0001",
buff.model.BuffEntryModelExpression.RATE_ADD,
buff.model.BuffEntryModelTargetType.MODEL,
1,
{
metadata: "BUFF_0001",
targetModel: new buff.model.BuffTargetModel(
"Gs2Experience:Status",
"rankCapValue",
new BuffTargetGrn[
new buff.model.BuffTargetGrn(
"Gs2Experience:ExperienceModel",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
),
new buff.model.BuffTargetGrn(
"Gs2Experience:ExperienceModel",
"rateModel",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002"
)
],
1.0
)
}
),
new buff.model.BuffEntryModel(
"buff-0002",
buff.model.BuffEntryModelExpression.MUL,
buff.model.BuffEntryModelTargetType.ACTION,
2,
{
metadata: "BUFF_0002",
targetAction: new buff.model.BuffTargetAction(
"Gs2Experience:AddExperienceByUserId",
"experienceValue",
new BuffTargetGrn[
new buff.model.BuffTargetGrn(
"Gs2Experience:ExperienceModel",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
)
],
2.0
)
}
),
new buff.model.BuffEntryModel(
"buff-0002",
buff.model.BuffEntryModelExpression.MUL,
buff.model.BuffEntryModelTargetType.MODEL,
3,
{
metadata: "BUFF_0002",
targetModel: new buff.model.BuffTargetModel(
"Gs2Experience:Status",
"rankCapValue",
new BuffTargetGrn[
new buff.model.BuffTargetGrn(
"Gs2Experience:ExperienceModel",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
)
],
3.0
)
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Buff.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Buff.Model.BuffEntryModel(
"buff-0001",
Gs2Cdk.Gs2Buff.Model.Enums.BuffEntryModelExpression.RateAdd,
Gs2Cdk.Gs2Buff.Model.Enums.BuffEntryModelTargetType.Model,
1,
new Gs2Cdk.Gs2Buff.Model.Options.BuffEntryModelOptions {
metadata = "BUFF_0001",
targetModel = new Gs2Cdk.Gs2Buff.Model.BuffTargetModel(
targetModelName: "Gs2Experience:Status",
targetFieldName: "rankCapValue",
conditionGrns: new Gs2Cdk.Gs2Buff.Model.BuffTargetGrn[] {
new Gs2Cdk.Gs2Buff.Model.BuffTargetGrn(
targetModelName: "Gs2Experience:ExperienceModel",
targetGrn: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
),
new Gs2Cdk.Gs2Buff.Model.BuffTargetGrn(
targetServiceName: "Gs2Experience:ExperienceModel",
targetModelName: "rateModel",
targetGrn: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002"
)
}
rate: 1.0f
)
}
),
new Gs2Cdk.Gs2Buff.Model.BuffEntryModel(
"buff-0002",
Gs2Cdk.Gs2Buff.Model.Enums.BuffEntryModelExpression.Mul,
Gs2Cdk.Gs2Buff.Model.Enums.BuffEntryModelTargetType.Action,
2,
new Gs2Cdk.Gs2Buff.Model.Options.BuffEntryModelOptions {
metadata = "BUFF_0002",
targetAction = new Gs2Cdk.Gs2Buff.Model.BuffTargetAction(
targetActionName: "Gs2Experience:AddExperienceByUserId",
targetFieldName: "experienceValue",
conditionGrns: new Gs2Cdk.Gs2Buff.Model.BuffTargetGrn[] {
new Gs2Cdk.Gs2Buff.Model.BuffTargetGrn(
targetModelName: "Gs2Experience:ExperienceModel",
targetGrn: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
)
}
rate: 2.0f
)
}
),
new Gs2Cdk.Gs2Buff.Model.BuffEntryModel(
"buff-0002",
Gs2Cdk.Gs2Buff.Model.Enums.BuffEntryModelExpression.Mul,
Gs2Cdk.Gs2Buff.Model.Enums.BuffEntryModelTargetType.Model,
3,
new Gs2Cdk.Gs2Buff.Model.Options.BuffEntryModelOptions {
metadata = "BUFF_0002",
targetModel = new Gs2Cdk.Gs2Buff.Model.BuffTargetModel(
targetModelName: "Gs2Experience:Status",
targetFieldName: "rankCapValue",
conditionGrns: new Gs2Cdk.Gs2Buff.Model.BuffTargetGrn[] {
new Gs2Cdk.Gs2Buff.Model.BuffTargetGrn(
targetModelName: "Gs2Experience:ExperienceModel",
targetGrn: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"
)
}
rate: 3.0f
)
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateBuffTargetModel
バフを適用する対象のモデル
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| targetModelName | enum { "Gs2Exchange:RateModel", "Gs2Exchange:IncrementalRateModel", "Gs2Experience:Status", "Gs2Formation:Mold", "Gs2Idle:CategoryModel", "Gs2Idle:Status", "Gs2Inventory:Inventory", "Gs2LoginReward:BonusModel", "Gs2Mission:MissionTaskModel", "Gs2Quest:QuestModel", "Gs2Showcase:DisplayItem", "Gs2Showcase:RandomDisplayItemModel", "Gs2SkillTree:NodeModel", "Gs2Stamina:Stamina", } | ✓ | ~ 128文字 | バフを適用するモデルの種類 | |
| targetFieldName | string | ✓ | ~ 64文字 | バフの適用対象フィールド名 | |
| conditionGrns | List<BuffTargetGrn> | ✓ | 1 ~ 10 items | バフの適用条件GRNのリスト | |
| rate | float | ✓ | ~ 1000000 | レート |
BuffTargetAction
バフを適用する対象のアクション
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| targetActionName | enum { "Gs2Experience:AddExperienceByUserId", "Gs2Experience:SubExperience", "Gs2Experience:SubExperienceByUserId", "Gs2Inventory:AcquireItemSetByUserId", "Gs2Inventory:ConsumeItemSet", "Gs2Inventory:ConsumeItemSetByUserId", "Gs2Inventory:AcquireSimpleItemsByUserId", "Gs2Inventory:ConsumeSimpleItems", "Gs2Inventory:ConsumeSimpleItemsByUserId", "Gs2Inventory:AcquireBigItemByUserId", "Gs2Inventory:ConsumeBigItem", "Gs2Inventory:ConsumeBigItemByUserId", "Gs2Limit:CountUp", "Gs2Limit:CountUpByUserId", "Gs2Money:DepositByUserId", "Gs2Money:Withdraw", "Gs2Money:WithdrawByUserId", "Gs2Money2:DepositByUserId", "Gs2Money2:Withdraw", "Gs2Money2:WithdrawByUserId", "Gs2Stamina:ConsumeStamina", "Gs2Stamina:ConsumeStaminaByUserId", "Gs2Stamina:RecoverStaminaByUserId", } | ✓ | ~ 128文字 | バフを適用するアクションの種類 | |
| targetFieldName | string | ✓ | ~ 64文字 | バフの適用対象フィールド名 | |
| conditionGrns | List<BuffTargetGrn> | ✓ | 1 ~ 10 items | バフの適用条件GRNのリスト | |
| rate | float | ✓ | ~ 1000000 | レート |
BuffTargetGrn
バフを適用するリソースのGRNパターン
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| targetModelName | string | ✓ | ~ 64文字 | バフの適用条件のモデル名 | |
| targetGrn | string | ✓ | ~ 1024文字 | バフの適用条件GRN |
OverrideBuffRate
バフの適用レート上書きモデル
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | バフエンティティ名 | |
| rate | float | ✓ | ~ 100 | レート |
ScriptSetting
スクリプト設定
GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。
スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることができます。
一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。
かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。
しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。
非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024文字 | スクリプトGRN | ||
| doneTriggerTargetType | enum { “none”, “gs2_script”, “aws” } | ✓ | “none” | ~ 128文字 | 完了通知の通知先 |
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | スクリプトGRN | |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | ネームスペースGRN |
doneTriggerTargetType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| none | なし |
| gs2_script | GS2-Script |
| aws | Amazon EventBridge |
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 |