GS2-Schedule GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 32文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| logSetting | LogSetting | ログの出力設定 |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Schedule::Namespace
Properties:
Name: namespace1
Description: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001from gs2_cdk import Stack, core, schedule
class SampleStack(Stack):
def __init__(self):
super().__init__()
schedule.Namespace(
stack=self,
name="namespace-0001",
options=schedule.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\Schedule\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Schedule\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.schedule.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.schedule.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 schedule from "@/gs2cdk/schedule";
class SampleStack extends core.Stack
{
public constructor() {
super();
new schedule.model.Namespace(
this,
"namespace-0001",
{
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Schedule.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Schedule.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateCurrentEventMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
| settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | CurrentEventMaster | 更新した現在有効なイベントスケジュールマスター |
実装例
Type: GS2::Schedule::CurrentEventMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-03-31",
"events": [
{
"name": "event-0001",
"metadata": "EVENT_0001",
"scheduleType": "absolute",
"absoluteBegin": 10000,
"absoluteEnd": 20000
},
{
"name": "event-0002",
"metadata": "EVENT_0002",
"scheduleType": "relative",
"relativeTriggerName": "trigger-0001",
"relativeDuration": 30000
},
{
"name": "daily-0001",
"metadata": "EVENT_0003",
"scheduleType": "absolute",
"absoluteBegin": 1569369600000,
"absoluteEnd": 1569456000000,
"repeatType": "daily",
"repeatBeginHour": 1,
"repeatEndHour": 2
},
{
"name": "daily-0002",
"metadata": "EVENT_0004",
"scheduleType": "absolute",
"absoluteBegin": 1569369600000,
"absoluteEnd": 1569456000000,
"repeatType": "daily",
"repeatBeginHour": 3,
"repeatEndHour": 1
},
{
"name": "weekly-0001",
"metadata": "EVENT_0005",
"scheduleType": "absolute",
"absoluteBegin": 1569888000000,
"absoluteEnd": 1570406400000,
"repeatType": "weekly",
"repeatBeginDayOfWeek": "tuesday",
"repeatEndDayOfWeek": "wednesday",
"repeatBeginHour": 1,
"repeatEndHour": 2
},
{
"name": "weekly-0002",
"metadata": "EVENT_0006",
"scheduleType": "absolute",
"absoluteBegin": 1569888000000,
"absoluteEnd": 1570406400000,
"repeatType": "weekly",
"repeatBeginDayOfWeek": "wednesday",
"repeatEndDayOfWeek": "tuesday",
"repeatBeginHour": 3,
"repeatEndHour": 1
},
{
"name": "monthly-0001",
"metadata": "EVENT_0007",
"scheduleType": "absolute",
"absoluteBegin": 1570406400000,
"absoluteEnd": 1575158400000,
"repeatType": "monthly",
"repeatBeginDayOfMonth": 10,
"repeatEndDayOfMonth": 15,
"repeatBeginHour": 1,
"repeatEndHour": 2
},
{
"name": "monthly-0002",
"metadata": "EVENT_0008",
"scheduleType": "absolute",
"absoluteBegin": 1570406400000,
"absoluteEnd": 1575158400000,
"repeatType": "monthly",
"repeatBeginDayOfMonth": 16,
"repeatEndDayOfMonth": 9,
"repeatBeginHour": 3,
"repeatEndHour": 0
}
]
}from gs2_cdk import Stack, core, schedule
class SampleStack(Stack):
def __init__(self):
super().__init__()
schedule.Namespace(
stack=self,
# 省略
).master_data(
[
schedule.Event(
name='event-0001',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0001',
absolute_begin=10000,
absolute_end=20000,
),
),
schedule.Event(
name='event-0002',
schedule_type='relative',
options=schedule.EventOptions(
metadata='EVENT_0002',
relative_trigger_name='trigger-0001',
relative_duration=30000,
),
),
schedule.Event(
name='daily-0001',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0003',
repeat_type='daily',
absolute_begin=1569369600000,
absolute_end=1569456000000,
repeat_begin_hour=1,
repeat_end_hour=2,
),
),
schedule.Event(
name='daily-0002',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0004',
repeat_type='daily',
absolute_begin=1569369600000,
absolute_end=1569456000000,
repeat_begin_hour=3,
repeat_end_hour=1,
),
),
schedule.Event(
name='weekly-0001',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0005',
repeat_type='weekly',
absolute_begin=1569888000000,
absolute_end=1570406400000,
repeat_begin_day_of_week='tuesday',
repeat_end_day_of_week='wednesday',
repeat_begin_hour=1,
repeat_end_hour=2,
),
),
schedule.Event(
name='weekly-0002',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0006',
repeat_type='weekly',
absolute_begin=1569888000000,
absolute_end=1570406400000,
repeat_begin_day_of_week='wednesday',
repeat_end_day_of_week='tuesday',
repeat_begin_hour=3,
repeat_end_hour=1,
),
),
schedule.Event(
name='monthly-0001',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0007',
repeat_type='monthly',
absolute_begin=1570406400000,
absolute_end=1575158400000,
repeat_begin_day_of_month=10,
repeat_end_day_of_month=15,
repeat_begin_hour=1,
repeat_end_hour=2,
),
),
schedule.Event(
name='monthly-0002',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0008',
repeat_type='monthly',
absolute_begin=1570406400000,
absolute_end=1575158400000,
repeat_begin_day_of_month=16,
repeat_end_day_of_month=9,
repeat_begin_hour=3,
),
),
],
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Schedule\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Schedule\Model\Event(
name:"event-0001",
scheduleType:"absolute",
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0001",
absoluteBegin:10000,
absoluteEnd:20000,
),
),
new \Gs2Cdk\Schedule\Model\Event(
name:"event-0002",
scheduleType:"relative",
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0002",
relativeTriggerName:"trigger-0001",
relativeDuration:30000,
),
),
new \Gs2Cdk\Schedule\Model\Event(
name:"daily-0001",
scheduleType:"absolute",
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0003",
repeatType:"daily",
absoluteBegin:1569369600000,
absoluteEnd:1569456000000,
repeatBeginHour:1,
repeatEndHour:2,
),
),
new \Gs2Cdk\Schedule\Model\Event(
name:"daily-0002",
scheduleType:"absolute",
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0004",
repeatType:"daily",
absoluteBegin:1569369600000,
absoluteEnd:1569456000000,
repeatBeginHour:3,
repeatEndHour:1,
),
),
new \Gs2Cdk\Schedule\Model\Event(
name:"weekly-0001",
scheduleType:"absolute",
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0005",
repeatType:"weekly",
absoluteBegin:1569888000000,
absoluteEnd:1570406400000,
repeatBeginDayOfWeek:"tuesday",
repeatEndDayOfWeek:"wednesday",
repeatBeginHour:1,
repeatEndHour:2,
),
),
new \Gs2Cdk\Schedule\Model\Event(
name:"weekly-0002",
scheduleType:"absolute",
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0006",
repeatType:"weekly",
absoluteBegin:1569888000000,
absoluteEnd:1570406400000,
repeatBeginDayOfWeek:"wednesday",
repeatEndDayOfWeek:"tuesday",
repeatBeginHour:3,
repeatEndHour:1,
),
),
new \Gs2Cdk\Schedule\Model\Event(
name:"monthly-0001",
scheduleType:"absolute",
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0007",
repeatType:"monthly",
absoluteBegin:1570406400000,
absoluteEnd:1575158400000,
repeatBeginDayOfMonth:10,
repeatEndDayOfMonth:15,
repeatBeginHour:1,
repeatEndHour:2,
),
),
new \Gs2Cdk\Schedule\Model\Event(
name:"monthly-0002",
scheduleType:"absolute",
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0008",
repeatType:"monthly",
absoluteBegin:1570406400000,
absoluteEnd:1575158400000,
repeatBeginDayOfMonth:16,
repeatEndDayOfMonth:9,
repeatBeginHour:3,
),
),
],
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.schedule.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.schedule.model.Event(
"event-0001",
"absolute",
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0001";
absoluteBegin: 10000L;
absoluteEnd: 20000L;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"event-0002",
"relative",
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0002";
relativeTriggerName: "trigger-0001";
relativeDuration: 30000;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"daily-0001",
"absolute",
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0003";
repeatType: "daily";
absoluteBegin: 1569369600000L;
absoluteEnd: 1569456000000L;
repeatBeginHour: 1;
repeatEndHour: 2;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"daily-0002",
"absolute",
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0004";
repeatType: "daily";
absoluteBegin: 1569369600000L;
absoluteEnd: 1569456000000L;
repeatBeginHour: 3;
repeatEndHour: 1;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"weekly-0001",
"absolute",
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0005";
repeatType: "weekly";
absoluteBegin: 1569888000000L;
absoluteEnd: 1570406400000L;
repeatBeginDayOfWeek: "tuesday";
repeatEndDayOfWeek: "wednesday";
repeatBeginHour: 1;
repeatEndHour: 2;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"weekly-0002",
"absolute",
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0006";
repeatType: "weekly";
absoluteBegin: 1569888000000L;
absoluteEnd: 1570406400000L;
repeatBeginDayOfWeek: "wednesday";
repeatEndDayOfWeek: "tuesday";
repeatBeginHour: 3;
repeatEndHour: 1;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"monthly-0001",
"absolute",
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0007";
repeatType: "monthly";
absoluteBegin: 1570406400000L;
absoluteEnd: 1575158400000L;
repeatBeginDayOfMonth: 10;
repeatEndDayOfMonth: 15;
repeatBeginHour: 1;
repeatEndHour: 2;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"monthly-0002",
"absolute",
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0008";
repeatType: "monthly";
absoluteBegin: 1570406400000L;
absoluteEnd: 1575158400000L;
repeatBeginDayOfMonth: 16;
repeatEndDayOfMonth: 9;
repeatBeginHour: 3;
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import schedule from "@/gs2cdk/schedule";
class SampleStack extends core.Stack
{
public constructor() {
super();
new schedule.model.Namespace(
this,
// 省略
).masterData(
[
new schedule.model.Event(
"event-0001",
"absolute",
{
metadata: "EVENT_0001",
absoluteBegin: 10000,
absoluteEnd: 20000
}
),
new schedule.model.Event(
"event-0002",
"relative",
{
metadata: "EVENT_0002",
relativeTriggerName: "trigger-0001",
relativeDuration: 30000
}
),
new schedule.model.Event(
"daily-0001",
"absolute",
{
metadata: "EVENT_0003",
repeatType: "daily",
absoluteBegin: 1569369600000,
absoluteEnd: 1569456000000,
repeatBeginHour: 1,
repeatEndHour: 2
}
),
new schedule.model.Event(
"daily-0002",
"absolute",
{
metadata: "EVENT_0004",
repeatType: "daily",
absoluteBegin: 1569369600000,
absoluteEnd: 1569456000000,
repeatBeginHour: 3,
repeatEndHour: 1
}
),
new schedule.model.Event(
"weekly-0001",
"absolute",
{
metadata: "EVENT_0005",
repeatType: "weekly",
absoluteBegin: 1569888000000,
absoluteEnd: 1570406400000,
repeatBeginDayOfWeek: "tuesday",
repeatEndDayOfWeek: "wednesday",
repeatBeginHour: 1,
repeatEndHour: 2
}
),
new schedule.model.Event(
"weekly-0002",
"absolute",
{
metadata: "EVENT_0006",
repeatType: "weekly",
absoluteBegin: 1569888000000,
absoluteEnd: 1570406400000,
repeatBeginDayOfWeek: "wednesday",
repeatEndDayOfWeek: "tuesday",
repeatBeginHour: 3,
repeatEndHour: 1
}
),
new schedule.model.Event(
"monthly-0001",
"absolute",
{
metadata: "EVENT_0007",
repeatType: "monthly",
absoluteBegin: 1570406400000,
absoluteEnd: 1575158400000,
repeatBeginDayOfMonth: 10,
repeatEndDayOfMonth: 15,
repeatBeginHour: 1,
repeatEndHour: 2
}
),
new schedule.model.Event(
"monthly-0002",
"absolute",
{
metadata: "EVENT_0008",
repeatType: "monthly",
absoluteBegin: 1570406400000,
absoluteEnd: 1575158400000,
repeatBeginDayOfMonth: 16,
repeatEndDayOfMonth: 9,
repeatBeginHour: 3
}
)
]
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Schedule.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Schedule.Model.Event(
"event-0001",
"absolute",
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0001",
absoluteBegin = 10000L,
absoluteEnd = 20000L,
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"event-0002",
"relative",
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0002",
relativeTriggerName = "trigger-0001",
relativeDuration = 30000,
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"daily-0001",
"absolute",
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0003",
repeatType = "daily",
absoluteBegin = 1569369600000L,
absoluteEnd = 1569456000000L,
repeatBeginHour = 1,
repeatEndHour = 2,
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"daily-0002",
"absolute",
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0004",
repeatType = "daily",
absoluteBegin = 1569369600000L,
absoluteEnd = 1569456000000L,
repeatBeginHour = 3,
repeatEndHour = 1,
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"weekly-0001",
"absolute",
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0005",
repeatType = "weekly",
absoluteBegin = 1569888000000L,
absoluteEnd = 1570406400000L,
repeatBeginDayOfWeek = "tuesday",
repeatEndDayOfWeek = "wednesday",
repeatBeginHour = 1,
repeatEndHour = 2,
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"weekly-0002",
"absolute",
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0006",
repeatType = "weekly",
absoluteBegin = 1569888000000L,
absoluteEnd = 1570406400000L,
repeatBeginDayOfWeek = "wednesday",
repeatEndDayOfWeek = "tuesday",
repeatBeginHour = 3,
repeatEndHour = 1,
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"monthly-0001",
"absolute",
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0007",
repeatType = "monthly",
absoluteBegin = 1570406400000L,
absoluteEnd = 1575158400000L,
repeatBeginDayOfMonth = 10,
repeatEndDayOfMonth = 15,
repeatBeginHour = 1,
repeatEndHour = 2,
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"monthly-0002",
"absolute",
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0008",
repeatType = "monthly",
absoluteBegin = 1570406400000L,
absoluteEnd = 1575158400000L,
repeatBeginDayOfMonth = 16,
repeatEndDayOfMonth = 9,
repeatBeginHour = 3,
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateGitHubCheckoutSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| 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
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |