GS2-Schedule GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | ネームスペース名 | |
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-0001
from 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 Template
class 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(
loggingNamespaceId = "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"
)
}
);
}
}
console.log(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(
LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
CurrentEventMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
Note
JSONファイルの形式については GS2-Schedule マスターデータリファレンス をご参照ください。型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | |
settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
型 | 説明 | |
---|---|---|
Item | CurrentEventMaster | 更新した現在有効なイベントスケジュールマスター |
実装例
Type: GS2::Schedule::CurrentEventMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-03-31",
"events": [
{
"name": "event-0001",
"scheduleType": "absolute",
"metadata": "EVENT_0001",
"absoluteBegin": 10000,
"absoluteEnd": 20000
},
{
"name": "event-0002",
"scheduleType": "relative",
"metadata": "EVENT_0002",
"relativeTriggerName": "trigger-0001"
},
{
"name": "daily-0001",
"scheduleType": "absolute",
"metadata": "EVENT_0003",
"absoluteBegin": 1569369600000,
"absoluteEnd": 1569456000000
},
{
"name": "daily-0002",
"scheduleType": "absolute",
"metadata": "EVENT_0004",
"absoluteBegin": 1569369600000,
"absoluteEnd": 1569456000000
},
{
"name": "weekly-0001",
"scheduleType": "absolute",
"metadata": "EVENT_0005",
"absoluteBegin": 1569888000000,
"absoluteEnd": 1570406400000
},
{
"name": "weekly-0002",
"scheduleType": "absolute",
"metadata": "EVENT_0006",
"absoluteBegin": 1569888000000,
"absoluteEnd": 1570406400000
},
{
"name": "monthly-0001",
"scheduleType": "absolute",
"metadata": "EVENT_0007",
"absoluteBegin": 1570406400000,
"absoluteEnd": 1575158400000
},
{
"name": "monthly-0002",
"scheduleType": "absolute",
"metadata": "EVENT_0008",
"absoluteBegin": 1570406400000,
"absoluteEnd": 1575158400000
}
]
}
from gs2_cdk import Stack, core, schedule
class SampleStack(Stack):
def __init__(self):
super().__init__()
schedule.Namespace(
stack=self,
# 省略
).master_data(
events=[
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',
),
),
schedule.Event(
name='daily-0001',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0003',
absolute_begin=1569369600000,
absolute_end=1569456000000,
),
),
schedule.Event(
name='daily-0002',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0004',
absolute_begin=1569369600000,
absolute_end=1569456000000,
),
),
schedule.Event(
name='weekly-0001',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0005',
absolute_begin=1569888000000,
absolute_end=1570406400000,
),
),
schedule.Event(
name='weekly-0002',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0006',
absolute_begin=1569888000000,
absolute_end=1570406400000,
),
),
schedule.Event(
name='monthly-0001',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0007',
absolute_begin=1570406400000,
absolute_end=1575158400000,
),
),
schedule.Event(
name='monthly-0002',
schedule_type='absolute',
options=schedule.EventOptions(
metadata='EVENT_0008',
absolute_begin=1570406400000,
absolute_end=1575158400000,
),
),
],
)
print(SampleStack().yaml()) # Generate Template
class 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: \Gs2Cdk\Schedule\Model\Enums\EventScheduleType::ABSOLUTE,
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0001",
absoluteBegin:10000,
absoluteEnd:20000
)
),
new \Gs2Cdk\Schedule\Model\Event(
name:"event-0002",
scheduleType: \Gs2Cdk\Schedule\Model\Enums\EventScheduleType::RELATIVE,
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0002",
relativeTriggerName:"trigger-0001"
)
),
new \Gs2Cdk\Schedule\Model\Event(
name:"daily-0001",
scheduleType: \Gs2Cdk\Schedule\Model\Enums\EventScheduleType::ABSOLUTE,
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0003",
absoluteBegin:1569369600000,
absoluteEnd:1569456000000
)
),
new \Gs2Cdk\Schedule\Model\Event(
name:"daily-0002",
scheduleType: \Gs2Cdk\Schedule\Model\Enums\EventScheduleType::ABSOLUTE,
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0004",
absoluteBegin:1569369600000,
absoluteEnd:1569456000000
)
),
new \Gs2Cdk\Schedule\Model\Event(
name:"weekly-0001",
scheduleType: \Gs2Cdk\Schedule\Model\Enums\EventScheduleType::ABSOLUTE,
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0005",
absoluteBegin:1569888000000,
absoluteEnd:1570406400000
)
),
new \Gs2Cdk\Schedule\Model\Event(
name:"weekly-0002",
scheduleType: \Gs2Cdk\Schedule\Model\Enums\EventScheduleType::ABSOLUTE,
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0006",
absoluteBegin:1569888000000,
absoluteEnd:1570406400000
)
),
new \Gs2Cdk\Schedule\Model\Event(
name:"monthly-0001",
scheduleType: \Gs2Cdk\Schedule\Model\Enums\EventScheduleType::ABSOLUTE,
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0007",
absoluteBegin:1570406400000,
absoluteEnd:1575158400000
)
),
new \Gs2Cdk\Schedule\Model\Event(
name:"monthly-0002",
scheduleType: \Gs2Cdk\Schedule\Model\Enums\EventScheduleType::ABSOLUTE,
options: new \Gs2Cdk\Schedule\Model\Options\EventOptions(
metadata:"EVENT_0008",
absoluteBegin:1570406400000,
absoluteEnd:1575158400000
)
)
]
);
}
}
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";
}
}
),
new io.gs2.cdk.schedule.model.Event(
"daily-0001",
Absolute,
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0003";
absoluteBegin: 1569369600000L;
absoluteEnd: 1569456000000L;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"daily-0002",
Absolute,
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0004";
absoluteBegin: 1569369600000L;
absoluteEnd: 1569456000000L;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"weekly-0001",
Absolute,
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0005";
absoluteBegin: 1569888000000L;
absoluteEnd: 1570406400000L;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"weekly-0002",
Absolute,
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0006";
absoluteBegin: 1569888000000L;
absoluteEnd: 1570406400000L;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"monthly-0001",
Absolute,
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0007";
absoluteBegin: 1570406400000L;
absoluteEnd: 1575158400000L;
}
}
),
new io.gs2.cdk.schedule.model.Event(
"monthly-0002",
Absolute,
new io.gs2.cdk.schedule.model.options.EventOptions() {
{
metadata: "EVENT_0008";
absoluteBegin: 1570406400000L;
absoluteEnd: 1575158400000L;
}
}
)
)
);
}
}
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",
schedule.model.EventScheduleType.ABSOLUTE,
{
metadata: "EVENT_0001",
absoluteBegin: 10000,
absoluteEnd: 20000
}
),
new schedule.model.Event(
"event-0002",
schedule.model.EventScheduleType.RELATIVE,
{
metadata: "EVENT_0002",
relativeTriggerName: "trigger-0001"
}
),
new schedule.model.Event(
"daily-0001",
schedule.model.EventScheduleType.ABSOLUTE,
{
metadata: "EVENT_0003",
absoluteBegin: 1569369600000,
absoluteEnd: 1569456000000
}
),
new schedule.model.Event(
"daily-0002",
schedule.model.EventScheduleType.ABSOLUTE,
{
metadata: "EVENT_0004",
absoluteBegin: 1569369600000,
absoluteEnd: 1569456000000
}
),
new schedule.model.Event(
"weekly-0001",
schedule.model.EventScheduleType.ABSOLUTE,
{
metadata: "EVENT_0005",
absoluteBegin: 1569888000000,
absoluteEnd: 1570406400000
}
),
new schedule.model.Event(
"weekly-0002",
schedule.model.EventScheduleType.ABSOLUTE,
{
metadata: "EVENT_0006",
absoluteBegin: 1569888000000,
absoluteEnd: 1570406400000
}
),
new schedule.model.Event(
"monthly-0001",
schedule.model.EventScheduleType.ABSOLUTE,
{
metadata: "EVENT_0007",
absoluteBegin: 1570406400000,
absoluteEnd: 1575158400000
}
),
new schedule.model.Event(
"monthly-0002",
schedule.model.EventScheduleType.ABSOLUTE,
{
metadata: "EVENT_0008",
absoluteBegin: 1570406400000,
absoluteEnd: 1575158400000
}
)
]
);
}
}
console.log(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",
Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0001",
absoluteBegin = 10000L,
absoluteEnd = 20000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"event-0002",
Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Relative,
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0002",
relativeTriggerName = "trigger-0001"
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"daily-0001",
Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0003",
absoluteBegin = 1569369600000L,
absoluteEnd = 1569456000000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"daily-0002",
Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0004",
absoluteBegin = 1569369600000L,
absoluteEnd = 1569456000000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"weekly-0001",
Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0005",
absoluteBegin = 1569888000000L,
absoluteEnd = 1570406400000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"weekly-0002",
Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0006",
absoluteBegin = 1569888000000L,
absoluteEnd = 1570406400000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"monthly-0001",
Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0007",
absoluteBegin = 1570406400000L,
absoluteEnd = 1575158400000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
"monthly-0002",
Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions {
metadata = "EVENT_0008",
absoluteBegin = 1570406400000L,
absoluteEnd = 1575158400000L
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
RepeatSetting
繰り返し設定
イベント期間のうち、月曜日の 10:00 ~ 11:00 だけをイベント期間とするような設定をする際に利用します。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
repeatType | enum { “always”, “daily”, “weekly”, “monthly”, “custom” } | ✓ | “always” | ~ 128文字 | 繰り返しの種類 |
beginDayOfMonth | int | {repeatType} == “monthly” | 1 ~ 31 | イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます) | |
endDayOfMonth | int | {repeatType} == “monthly” | 1 ~ 31 | イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます) | |
beginDayOfWeek | enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ~ 128文字 | イベントの繰り返し開始曜日 | |
endDayOfWeek | enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ~ 128文字 | イベントの繰り返し終了曜日 | |
beginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ~ 23 | イベントの繰り返し開始時間(単位:時) | |
endHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ~ 24 | イベントの繰り返し終了時間(単位:時) | |
anchorTimestamp | long | {repeatType} == “custom” | サイクルを開始する基準日 (UNIX時間 単位:ミリ秒) | ||
activeDays | int | {repeatType} == “custom” | 1 ~ 2147483646.0 | サイクル内のアクティブな日数 | |
inactiveDays | int | {repeatType} == “custom” | 1 ~ 2147483646.0 | サイクル内のインアクティブな日数 |
repeatType に指定する列挙型の定義
定義 | 説明 |
---|---|
always | イベント期間 常時 |
daily | イベント期間のうち 毎日X時~X時 |
weekly | イベント期間のうち 毎週X曜日 X時~X時 |
monthly | イベント期間のうち 毎月X日 X時~X時 |
custom | 基準日から始まり、イベント期間中、X日アクティブ、Y日インアクティブを繰り返す |
beginDayOfWeek に指定する列挙型の定義
定義 | 説明 |
---|---|
sunday | 日曜日 |
monday | 月曜日 |
tuesday | 火曜日 |
wednesday | 水曜日 |
thursday | 木曜日 |
friday | 金曜日 |
saturday | 土曜日 |
endDayOfWeek に指定する列挙型の定義
定義 | 説明 |
---|---|
sunday | 日曜日 |
monday | 月曜日 |
tuesday | 火曜日 |
wednesday | 水曜日 |
thursday | 木曜日 |
friday | 金曜日 |
saturday | 土曜日 |
RepeatSchedule
スケジュールの繰り返し状態
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
repeatCount | int | ✓ | ~ 2147483646 | 繰り返し回数 | |
currentRepeatStartAt | long | リピート中のイベントの開始日時 (UNIX時間 単位:ミリ秒) | |||
currentRepeatEndAt | long | リピート中のイベントの終了日時 (UNIX時間 単位:ミリ秒) | |||
lastRepeatEndAt | long | 前回のイベントの終了日時 (UNIX時間 単位:ミリ秒) | |||
nextRepeatStartAt | long | 次回のイベントの開始日時 (UNIX時間 単位:ミリ秒) |
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 |