GS2-Deploy/CDK Reference of GS2-Schedule
Template format used to create GS2-Deploy stacks and examples of template output implementation in various languages using CDK
Entities
Namespace
Namespace
A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.
Therefore, you must create a namespace before you can start using each service.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Namespace name | ||
| description | string | ~ 1024 chars | Description | |||
| transactionSetting | TransactionSetting | Transaction settings | ||||
| logSetting | LogSetting | Log output settings |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | Namespace | Namespace created |
Implementation Example
Type: GS2::Schedule::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/schedule"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
schedule.NewNamespace(
&SampleStack,
"namespace-0001",
schedule.NamespaceOptions{
LogSetting: &core.LogSetting{
LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
},
},
)
println(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()
.withLogSetting(new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
))
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Schedule.Model.Namespace(
stack: this,
name: "namespace-0001",
options: 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 Templateimport 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
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 TemplateCurrentEventMaster
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.
To create JSON files, we provide a master data editor within the management console. Additionally, you can utilize the service by creating tools more suited to game operations and exporting JSON files in the appropriate format.
Note
Please refer to Master Data Reference of GS2-Schedule for the JSON file format.| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name | ||||||||
| mode | String Enum enum { “direct”, “preUpload” } | ✓ | “direct” | ~ 128 chars | Update mode
| |||||||
| settings | string | {mode} == “direct” | ✓* | ~ 5242880 chars | Master Data * Required if mode is “direct” | |||||||
| uploadToken | string | {mode} == “preUpload” | ✓* | ~ 1024 chars | Token used to reflect results after upload * Required if mode is “preUpload” |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentEventMaster | Updated and currently available event schedule master |
Implementation Example
Type: GS2::Schedule::CurrentEventMaster
Properties:
NamespaceName: namespace-0001
Mode: null
Settings: {
"version": "2019-03-31",
"events": [
{
"name": "event-0001",
"scheduleType": "absolute",
"repeatSetting":
{
"repeatType": "always",
"beginDayOfMonth": 1,
"endDayOfMonth": 1,
"beginHour": 0,
"endHour": 0,
"activeDays": 1,
"inactiveDays": 0
},
"metadata": "EVENT_0001",
"absoluteBegin": 10000,
"absoluteEnd": 20000
},
{
"name": "event-0002",
"scheduleType": "relative",
"repeatSetting":
{
"repeatType": "always",
"beginDayOfMonth": 1,
"endDayOfMonth": 1,
"beginHour": 0,
"endHour": 0,
"activeDays": 1,
"inactiveDays": 0
},
"metadata": "EVENT_0002",
"relativeTriggerName": "trigger-0001"
},
{
"name": "daily-0001",
"scheduleType": "absolute",
"repeatSetting":
{
"repeatType": "always",
"beginDayOfMonth": 1,
"endDayOfMonth": 1,
"beginHour": 0,
"endHour": 0,
"activeDays": 1,
"inactiveDays": 0
},
"metadata": "EVENT_0003",
"absoluteBegin": 1569369600000,
"absoluteEnd": 1569456000000
},
{
"name": "daily-0002",
"scheduleType": "absolute",
"repeatSetting":
{
"repeatType": "always",
"beginDayOfMonth": 1,
"endDayOfMonth": 1,
"beginHour": 0,
"endHour": 0,
"activeDays": 1,
"inactiveDays": 0
},
"metadata": "EVENT_0004",
"absoluteBegin": 1569369600000,
"absoluteEnd": 1569456000000
},
{
"name": "weekly-0001",
"scheduleType": "absolute",
"repeatSetting":
{
"repeatType": "always",
"beginDayOfMonth": 1,
"endDayOfMonth": 1,
"beginHour": 0,
"endHour": 0,
"activeDays": 1,
"inactiveDays": 0
},
"metadata": "EVENT_0005",
"absoluteBegin": 1569888000000,
"absoluteEnd": 1570406400000
},
{
"name": "weekly-0002",
"scheduleType": "absolute",
"repeatSetting":
{
"repeatType": "always",
"beginDayOfMonth": 1,
"endDayOfMonth": 1,
"beginHour": 0,
"endHour": 0,
"activeDays": 1,
"inactiveDays": 0
},
"metadata": "EVENT_0006",
"absoluteBegin": 1569888000000,
"absoluteEnd": 1570406400000
},
{
"name": "monthly-0001",
"scheduleType": "absolute",
"repeatSetting":
{
"repeatType": "always",
"beginDayOfMonth": 1,
"endDayOfMonth": 1,
"beginHour": 0,
"endHour": 0,
"activeDays": 1,
"inactiveDays": 0
},
"metadata": "EVENT_0007",
"absoluteBegin": 1570406400000,
"absoluteEnd": 1575158400000
},
{
"name": "monthly-0002",
"scheduleType": "absolute",
"repeatSetting":
{
"repeatType": "always",
"beginDayOfMonth": 1,
"endDayOfMonth": 1,
"beginHour": 0,
"endHour": 0,
"activeDays": 1,
"inactiveDays": 0
},
"metadata": "EVENT_0008",
"absoluteBegin": 1570406400000,
"absoluteEnd": 1575158400000
}
]
}
UploadToken: nullimport (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/schedule"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
schedule.NewNamespace(
&SampleStack,
"namespace-0001",
schedule.NamespaceOptions{},
).MasterData(
[]schedule.Event{
schedule.NewEvent(
"event-0001",
schedule.EventScheduleTypeAbsolute,
schedule.NewRepeatSetting(
schedule.RepeatSettingRepeatTypeAlways,
schedule.RepeatSettingOptions{
BeginDayOfMonth: pointy.Int32(1),
EndDayOfMonth: pointy.Int32(1),
BeginHour: pointy.Int32(0),
EndHour: pointy.Int32(0),
ActiveDays: pointy.Int32(1),
InactiveDays: pointy.Int32(0),
},
),
schedule.EventOptions{
Metadata: pointy.String("EVENT_0001"),
AbsoluteBegin: pointy.Int64(10000),
AbsoluteEnd: pointy.Int64(20000),
},
),
schedule.NewEvent(
"event-0002",
schedule.EventScheduleTypeRelative,
schedule.NewRepeatSetting(
schedule.RepeatSettingRepeatTypeAlways,
schedule.RepeatSettingOptions{
BeginDayOfMonth: pointy.Int32(1),
EndDayOfMonth: pointy.Int32(1),
BeginHour: pointy.Int32(0),
EndHour: pointy.Int32(0),
ActiveDays: pointy.Int32(1),
InactiveDays: pointy.Int32(0),
},
),
schedule.EventOptions{
Metadata: pointy.String("EVENT_0002"),
RelativeTriggerName: pointy.String("trigger-0001"),
},
),
schedule.NewEvent(
"daily-0001",
schedule.EventScheduleTypeAbsolute,
schedule.NewRepeatSetting(
schedule.RepeatSettingRepeatTypeAlways,
schedule.RepeatSettingOptions{
BeginDayOfMonth: pointy.Int32(1),
EndDayOfMonth: pointy.Int32(1),
BeginHour: pointy.Int32(0),
EndHour: pointy.Int32(0),
ActiveDays: pointy.Int32(1),
InactiveDays: pointy.Int32(0),
},
),
schedule.EventOptions{
Metadata: pointy.String("EVENT_0003"),
AbsoluteBegin: pointy.Int64(1569369600000),
AbsoluteEnd: pointy.Int64(1569456000000),
},
),
schedule.NewEvent(
"daily-0002",
schedule.EventScheduleTypeAbsolute,
schedule.NewRepeatSetting(
schedule.RepeatSettingRepeatTypeAlways,
schedule.RepeatSettingOptions{
BeginDayOfMonth: pointy.Int32(1),
EndDayOfMonth: pointy.Int32(1),
BeginHour: pointy.Int32(0),
EndHour: pointy.Int32(0),
ActiveDays: pointy.Int32(1),
InactiveDays: pointy.Int32(0),
},
),
schedule.EventOptions{
Metadata: pointy.String("EVENT_0004"),
AbsoluteBegin: pointy.Int64(1569369600000),
AbsoluteEnd: pointy.Int64(1569456000000),
},
),
schedule.NewEvent(
"weekly-0001",
schedule.EventScheduleTypeAbsolute,
schedule.NewRepeatSetting(
schedule.RepeatSettingRepeatTypeAlways,
schedule.RepeatSettingOptions{
BeginDayOfMonth: pointy.Int32(1),
EndDayOfMonth: pointy.Int32(1),
BeginHour: pointy.Int32(0),
EndHour: pointy.Int32(0),
ActiveDays: pointy.Int32(1),
InactiveDays: pointy.Int32(0),
},
),
schedule.EventOptions{
Metadata: pointy.String("EVENT_0005"),
AbsoluteBegin: pointy.Int64(1569888000000),
AbsoluteEnd: pointy.Int64(1570406400000),
},
),
schedule.NewEvent(
"weekly-0002",
schedule.EventScheduleTypeAbsolute,
schedule.NewRepeatSetting(
schedule.RepeatSettingRepeatTypeAlways,
schedule.RepeatSettingOptions{
BeginDayOfMonth: pointy.Int32(1),
EndDayOfMonth: pointy.Int32(1),
BeginHour: pointy.Int32(0),
EndHour: pointy.Int32(0),
ActiveDays: pointy.Int32(1),
InactiveDays: pointy.Int32(0),
},
),
schedule.EventOptions{
Metadata: pointy.String("EVENT_0006"),
AbsoluteBegin: pointy.Int64(1569888000000),
AbsoluteEnd: pointy.Int64(1570406400000),
},
),
schedule.NewEvent(
"monthly-0001",
schedule.EventScheduleTypeAbsolute,
schedule.NewRepeatSetting(
schedule.RepeatSettingRepeatTypeAlways,
schedule.RepeatSettingOptions{
BeginDayOfMonth: pointy.Int32(1),
EndDayOfMonth: pointy.Int32(1),
BeginHour: pointy.Int32(0),
EndHour: pointy.Int32(0),
ActiveDays: pointy.Int32(1),
InactiveDays: pointy.Int32(0),
},
),
schedule.EventOptions{
Metadata: pointy.String("EVENT_0007"),
AbsoluteBegin: pointy.Int64(1570406400000),
AbsoluteEnd: pointy.Int64(1575158400000),
},
),
schedule.NewEvent(
"monthly-0002",
schedule.EventScheduleTypeAbsolute,
schedule.NewRepeatSetting(
schedule.RepeatSettingRepeatTypeAlways,
schedule.RepeatSettingOptions{
BeginDayOfMonth: pointy.Int32(1),
EndDayOfMonth: pointy.Int32(1),
BeginHour: pointy.Int32(0),
EndHour: pointy.Int32(0),
ActiveDays: pointy.Int32(1),
InactiveDays: pointy.Int32(0),
},
),
schedule.EventOptions{
Metadata: pointy.String("EVENT_0008"),
AbsoluteBegin: pointy.Int64(1570406400000),
AbsoluteEnd: pointy.Int64(1575158400000),
},
),
},
)
println(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"
))->masterData(
[
new \Gs2Cdk\Schedule\Model\Event(
name:"event-0001",
scheduleType: \Gs2Cdk\Schedule\Model\Enums\EventScheduleType::ABSOLUTE,
repeatSetting:new \Gs2Cdk\Schedule\Model\RepeatSetting(
repeatType: Gs2Cdk\Schedule\Model\Enums\RepeatSettingRepeatType::ALWAYS,
options: new \Gs2Cdk\Schedule\Model\Options\RepeatSettingOptions(
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0,
)
),
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,
repeatSetting:new \Gs2Cdk\Schedule\Model\RepeatSetting(
repeatType: Gs2Cdk\Schedule\Model\Enums\RepeatSettingRepeatType::ALWAYS,
options: new \Gs2Cdk\Schedule\Model\Options\RepeatSettingOptions(
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0,
)
),
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,
repeatSetting:new \Gs2Cdk\Schedule\Model\RepeatSetting(
repeatType: Gs2Cdk\Schedule\Model\Enums\RepeatSettingRepeatType::ALWAYS,
options: new \Gs2Cdk\Schedule\Model\Options\RepeatSettingOptions(
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0,
)
),
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,
repeatSetting:new \Gs2Cdk\Schedule\Model\RepeatSetting(
repeatType: Gs2Cdk\Schedule\Model\Enums\RepeatSettingRepeatType::ALWAYS,
options: new \Gs2Cdk\Schedule\Model\Options\RepeatSettingOptions(
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0,
)
),
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,
repeatSetting:new \Gs2Cdk\Schedule\Model\RepeatSetting(
repeatType: Gs2Cdk\Schedule\Model\Enums\RepeatSettingRepeatType::ALWAYS,
options: new \Gs2Cdk\Schedule\Model\Options\RepeatSettingOptions(
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0,
)
),
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,
repeatSetting:new \Gs2Cdk\Schedule\Model\RepeatSetting(
repeatType: Gs2Cdk\Schedule\Model\Enums\RepeatSettingRepeatType::ALWAYS,
options: new \Gs2Cdk\Schedule\Model\Options\RepeatSettingOptions(
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0,
)
),
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,
repeatSetting:new \Gs2Cdk\Schedule\Model\RepeatSetting(
repeatType: Gs2Cdk\Schedule\Model\Enums\RepeatSettingRepeatType::ALWAYS,
options: new \Gs2Cdk\Schedule\Model\Options\RepeatSettingOptions(
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0,
)
),
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,
repeatSetting:new \Gs2Cdk\Schedule\Model\RepeatSetting(
repeatType: Gs2Cdk\Schedule\Model\Enums\RepeatSettingRepeatType::ALWAYS,
options: new \Gs2Cdk\Schedule\Model\Options\RepeatSettingOptions(
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0,
)
),
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,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.schedule.model.Event(
"event-0001",
io.gs2.cdk.schedule.model.enums.EventScheduleType.ABSOLUTE,
new io.gs2.cdk.schedule.model.RepeatSetting(
io.gs2.cdk.schedule.model.enums.RepeatSettingRepeatType.ALWAYS,
new io.gs2.cdk.schedule.model.options.RepeatSettingOptions()
.withBeginDayOfMonth(1)
.withEndDayOfMonth(1)
.withBeginHour(0)
.withEndHour(0)
.withActiveDays(1)
.withInactiveDays(0)
),
new io.gs2.cdk.schedule.model.options.EventOptions()
.withMetadata("EVENT_0001")
.withAbsoluteBegin(10000L)
.withAbsoluteEnd(20000L)
),
new io.gs2.cdk.schedule.model.Event(
"event-0002",
io.gs2.cdk.schedule.model.enums.EventScheduleType.RELATIVE,
new io.gs2.cdk.schedule.model.RepeatSetting(
io.gs2.cdk.schedule.model.enums.RepeatSettingRepeatType.ALWAYS,
new io.gs2.cdk.schedule.model.options.RepeatSettingOptions()
.withBeginDayOfMonth(1)
.withEndDayOfMonth(1)
.withBeginHour(0)
.withEndHour(0)
.withActiveDays(1)
.withInactiveDays(0)
),
new io.gs2.cdk.schedule.model.options.EventOptions()
.withMetadata("EVENT_0002")
.withRelativeTriggerName("trigger-0001")
),
new io.gs2.cdk.schedule.model.Event(
"daily-0001",
io.gs2.cdk.schedule.model.enums.EventScheduleType.ABSOLUTE,
new io.gs2.cdk.schedule.model.RepeatSetting(
io.gs2.cdk.schedule.model.enums.RepeatSettingRepeatType.ALWAYS,
new io.gs2.cdk.schedule.model.options.RepeatSettingOptions()
.withBeginDayOfMonth(1)
.withEndDayOfMonth(1)
.withBeginHour(0)
.withEndHour(0)
.withActiveDays(1)
.withInactiveDays(0)
),
new io.gs2.cdk.schedule.model.options.EventOptions()
.withMetadata("EVENT_0003")
.withAbsoluteBegin(1569369600000L)
.withAbsoluteEnd(1569456000000L)
),
new io.gs2.cdk.schedule.model.Event(
"daily-0002",
io.gs2.cdk.schedule.model.enums.EventScheduleType.ABSOLUTE,
new io.gs2.cdk.schedule.model.RepeatSetting(
io.gs2.cdk.schedule.model.enums.RepeatSettingRepeatType.ALWAYS,
new io.gs2.cdk.schedule.model.options.RepeatSettingOptions()
.withBeginDayOfMonth(1)
.withEndDayOfMonth(1)
.withBeginHour(0)
.withEndHour(0)
.withActiveDays(1)
.withInactiveDays(0)
),
new io.gs2.cdk.schedule.model.options.EventOptions()
.withMetadata("EVENT_0004")
.withAbsoluteBegin(1569369600000L)
.withAbsoluteEnd(1569456000000L)
),
new io.gs2.cdk.schedule.model.Event(
"weekly-0001",
io.gs2.cdk.schedule.model.enums.EventScheduleType.ABSOLUTE,
new io.gs2.cdk.schedule.model.RepeatSetting(
io.gs2.cdk.schedule.model.enums.RepeatSettingRepeatType.ALWAYS,
new io.gs2.cdk.schedule.model.options.RepeatSettingOptions()
.withBeginDayOfMonth(1)
.withEndDayOfMonth(1)
.withBeginHour(0)
.withEndHour(0)
.withActiveDays(1)
.withInactiveDays(0)
),
new io.gs2.cdk.schedule.model.options.EventOptions()
.withMetadata("EVENT_0005")
.withAbsoluteBegin(1569888000000L)
.withAbsoluteEnd(1570406400000L)
),
new io.gs2.cdk.schedule.model.Event(
"weekly-0002",
io.gs2.cdk.schedule.model.enums.EventScheduleType.ABSOLUTE,
new io.gs2.cdk.schedule.model.RepeatSetting(
io.gs2.cdk.schedule.model.enums.RepeatSettingRepeatType.ALWAYS,
new io.gs2.cdk.schedule.model.options.RepeatSettingOptions()
.withBeginDayOfMonth(1)
.withEndDayOfMonth(1)
.withBeginHour(0)
.withEndHour(0)
.withActiveDays(1)
.withInactiveDays(0)
),
new io.gs2.cdk.schedule.model.options.EventOptions()
.withMetadata("EVENT_0006")
.withAbsoluteBegin(1569888000000L)
.withAbsoluteEnd(1570406400000L)
),
new io.gs2.cdk.schedule.model.Event(
"monthly-0001",
io.gs2.cdk.schedule.model.enums.EventScheduleType.ABSOLUTE,
new io.gs2.cdk.schedule.model.RepeatSetting(
io.gs2.cdk.schedule.model.enums.RepeatSettingRepeatType.ALWAYS,
new io.gs2.cdk.schedule.model.options.RepeatSettingOptions()
.withBeginDayOfMonth(1)
.withEndDayOfMonth(1)
.withBeginHour(0)
.withEndHour(0)
.withActiveDays(1)
.withInactiveDays(0)
),
new io.gs2.cdk.schedule.model.options.EventOptions()
.withMetadata("EVENT_0007")
.withAbsoluteBegin(1570406400000L)
.withAbsoluteEnd(1575158400000L)
),
new io.gs2.cdk.schedule.model.Event(
"monthly-0002",
io.gs2.cdk.schedule.model.enums.EventScheduleType.ABSOLUTE,
new io.gs2.cdk.schedule.model.RepeatSetting(
io.gs2.cdk.schedule.model.enums.RepeatSettingRepeatType.ALWAYS,
new io.gs2.cdk.schedule.model.options.RepeatSettingOptions()
.withBeginDayOfMonth(1)
.withEndDayOfMonth(1)
.withBeginHour(0)
.withEndHour(0)
.withActiveDays(1)
.withInactiveDays(0)
),
new io.gs2.cdk.schedule.model.options.EventOptions()
.withMetadata("EVENT_0008")
.withAbsoluteBegin(1570406400000L)
.withAbsoluteEnd(1575158400000L)
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Schedule.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Schedule.Model.Event[] {
new Gs2Cdk.Gs2Schedule.Model.Event(
name: "event-0001",
scheduleType: Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
repeatSetting: new Gs2Cdk.Gs2Schedule.Model.RepeatSetting(
repeatType: Gs2Cdk.Gs2Schedule.Model.Enums.RepeatSettingRepeatType.Always,
options: new Gs2Cdk.Gs2Schedule.Model.Options.RepeatSettingOptions
{
beginDayOfMonth = 1,
endDayOfMonth = 1,
beginHour = 0,
endHour = 0,
activeDays = 1,
inactiveDays = 0
}
),
options: new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions
{
metadata = "EVENT_0001",
absoluteBegin = 10000L,
absoluteEnd = 20000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
name: "event-0002",
scheduleType: Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Relative,
repeatSetting: new Gs2Cdk.Gs2Schedule.Model.RepeatSetting(
repeatType: Gs2Cdk.Gs2Schedule.Model.Enums.RepeatSettingRepeatType.Always,
options: new Gs2Cdk.Gs2Schedule.Model.Options.RepeatSettingOptions
{
beginDayOfMonth = 1,
endDayOfMonth = 1,
beginHour = 0,
endHour = 0,
activeDays = 1,
inactiveDays = 0
}
),
options: new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions
{
metadata = "EVENT_0002",
relativeTriggerName = "trigger-0001"
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
name: "daily-0001",
scheduleType: Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
repeatSetting: new Gs2Cdk.Gs2Schedule.Model.RepeatSetting(
repeatType: Gs2Cdk.Gs2Schedule.Model.Enums.RepeatSettingRepeatType.Always,
options: new Gs2Cdk.Gs2Schedule.Model.Options.RepeatSettingOptions
{
beginDayOfMonth = 1,
endDayOfMonth = 1,
beginHour = 0,
endHour = 0,
activeDays = 1,
inactiveDays = 0
}
),
options: new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions
{
metadata = "EVENT_0003",
absoluteBegin = 1569369600000L,
absoluteEnd = 1569456000000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
name: "daily-0002",
scheduleType: Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
repeatSetting: new Gs2Cdk.Gs2Schedule.Model.RepeatSetting(
repeatType: Gs2Cdk.Gs2Schedule.Model.Enums.RepeatSettingRepeatType.Always,
options: new Gs2Cdk.Gs2Schedule.Model.Options.RepeatSettingOptions
{
beginDayOfMonth = 1,
endDayOfMonth = 1,
beginHour = 0,
endHour = 0,
activeDays = 1,
inactiveDays = 0
}
),
options: new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions
{
metadata = "EVENT_0004",
absoluteBegin = 1569369600000L,
absoluteEnd = 1569456000000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
name: "weekly-0001",
scheduleType: Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
repeatSetting: new Gs2Cdk.Gs2Schedule.Model.RepeatSetting(
repeatType: Gs2Cdk.Gs2Schedule.Model.Enums.RepeatSettingRepeatType.Always,
options: new Gs2Cdk.Gs2Schedule.Model.Options.RepeatSettingOptions
{
beginDayOfMonth = 1,
endDayOfMonth = 1,
beginHour = 0,
endHour = 0,
activeDays = 1,
inactiveDays = 0
}
),
options: new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions
{
metadata = "EVENT_0005",
absoluteBegin = 1569888000000L,
absoluteEnd = 1570406400000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
name: "weekly-0002",
scheduleType: Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
repeatSetting: new Gs2Cdk.Gs2Schedule.Model.RepeatSetting(
repeatType: Gs2Cdk.Gs2Schedule.Model.Enums.RepeatSettingRepeatType.Always,
options: new Gs2Cdk.Gs2Schedule.Model.Options.RepeatSettingOptions
{
beginDayOfMonth = 1,
endDayOfMonth = 1,
beginHour = 0,
endHour = 0,
activeDays = 1,
inactiveDays = 0
}
),
options: new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions
{
metadata = "EVENT_0006",
absoluteBegin = 1569888000000L,
absoluteEnd = 1570406400000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
name: "monthly-0001",
scheduleType: Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
repeatSetting: new Gs2Cdk.Gs2Schedule.Model.RepeatSetting(
repeatType: Gs2Cdk.Gs2Schedule.Model.Enums.RepeatSettingRepeatType.Always,
options: new Gs2Cdk.Gs2Schedule.Model.Options.RepeatSettingOptions
{
beginDayOfMonth = 1,
endDayOfMonth = 1,
beginHour = 0,
endHour = 0,
activeDays = 1,
inactiveDays = 0
}
),
options: new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions
{
metadata = "EVENT_0007",
absoluteBegin = 1570406400000L,
absoluteEnd = 1575158400000L
}
),
new Gs2Cdk.Gs2Schedule.Model.Event(
name: "monthly-0002",
scheduleType: Gs2Cdk.Gs2Schedule.Model.Enums.EventScheduleType.Absolute,
repeatSetting: new Gs2Cdk.Gs2Schedule.Model.RepeatSetting(
repeatType: Gs2Cdk.Gs2Schedule.Model.Enums.RepeatSettingRepeatType.Always,
options: new Gs2Cdk.Gs2Schedule.Model.Options.RepeatSettingOptions
{
beginDayOfMonth = 1,
endDayOfMonth = 1,
beginHour = 0,
endHour = 0,
activeDays = 1,
inactiveDays = 0
}
),
options: new Gs2Cdk.Gs2Schedule.Model.Options.EventOptions
{
metadata = "EVENT_0008",
absoluteBegin = 1570406400000L,
absoluteEnd = 1575158400000L
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import schedule from "@/gs2cdk/schedule";
class SampleStack extends core.Stack
{
public constructor() {
super();
new schedule.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new schedule.model.Event(
"event-0001",
schedule.model.EventScheduleType.ABSOLUTE,
new schedule.model.RepeatSetting(
schedule.model.RepeatSettingRepeatType.ALWAYS,
{
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0
}
),
{
metadata: "EVENT_0001",
absoluteBegin: 10000,
absoluteEnd: 20000
}
),
new schedule.model.Event(
"event-0002",
schedule.model.EventScheduleType.RELATIVE,
new schedule.model.RepeatSetting(
schedule.model.RepeatSettingRepeatType.ALWAYS,
{
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0
}
),
{
metadata: "EVENT_0002",
relativeTriggerName: "trigger-0001"
}
),
new schedule.model.Event(
"daily-0001",
schedule.model.EventScheduleType.ABSOLUTE,
new schedule.model.RepeatSetting(
schedule.model.RepeatSettingRepeatType.ALWAYS,
{
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0
}
),
{
metadata: "EVENT_0003",
absoluteBegin: 1569369600000,
absoluteEnd: 1569456000000
}
),
new schedule.model.Event(
"daily-0002",
schedule.model.EventScheduleType.ABSOLUTE,
new schedule.model.RepeatSetting(
schedule.model.RepeatSettingRepeatType.ALWAYS,
{
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0
}
),
{
metadata: "EVENT_0004",
absoluteBegin: 1569369600000,
absoluteEnd: 1569456000000
}
),
new schedule.model.Event(
"weekly-0001",
schedule.model.EventScheduleType.ABSOLUTE,
new schedule.model.RepeatSetting(
schedule.model.RepeatSettingRepeatType.ALWAYS,
{
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0
}
),
{
metadata: "EVENT_0005",
absoluteBegin: 1569888000000,
absoluteEnd: 1570406400000
}
),
new schedule.model.Event(
"weekly-0002",
schedule.model.EventScheduleType.ABSOLUTE,
new schedule.model.RepeatSetting(
schedule.model.RepeatSettingRepeatType.ALWAYS,
{
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0
}
),
{
metadata: "EVENT_0006",
absoluteBegin: 1569888000000,
absoluteEnd: 1570406400000
}
),
new schedule.model.Event(
"monthly-0001",
schedule.model.EventScheduleType.ABSOLUTE,
new schedule.model.RepeatSetting(
schedule.model.RepeatSettingRepeatType.ALWAYS,
{
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0
}
),
{
metadata: "EVENT_0007",
absoluteBegin: 1570406400000,
absoluteEnd: 1575158400000
}
),
new schedule.model.Event(
"monthly-0002",
schedule.model.EventScheduleType.ABSOLUTE,
new schedule.model.RepeatSetting(
schedule.model.RepeatSettingRepeatType.ALWAYS,
{
beginDayOfMonth: 1,
endDayOfMonth: 1,
beginHour: 0,
endHour: 0,
activeDays: 1,
inactiveDays: 0
}
),
{
metadata: "EVENT_0008",
absoluteBegin: 1570406400000,
absoluteEnd: 1575158400000
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, schedule
class SampleStack(Stack):
def __init__(self):
super().__init__()
schedule.Namespace(
stack=self,
name="namespace-0001",
).master_data(
events=[
schedule.Event(
name='event-0001',
schedule_type=schedule.EventScheduleType.ABSOLUTE,
repeat_setting=schedule.RepeatSetting(
repeat_type=schedule.RepeatSettingRepeatType.ALWAYS,
options=schedule.RepeatSettingOptions(
begin_day_of_month=1,
end_day_of_month=1,
begin_hour=0,
end_hour=0,
active_days=1,
inactive_days=0,
),
),
options=schedule.EventOptions(
metadata = 'EVENT_0001',
absolute_begin = 10000,
absolute_end = 20000
),
),
schedule.Event(
name='event-0002',
schedule_type=schedule.EventScheduleType.RELATIVE,
repeat_setting=schedule.RepeatSetting(
repeat_type=schedule.RepeatSettingRepeatType.ALWAYS,
options=schedule.RepeatSettingOptions(
begin_day_of_month=1,
end_day_of_month=1,
begin_hour=0,
end_hour=0,
active_days=1,
inactive_days=0,
),
),
options=schedule.EventOptions(
metadata = 'EVENT_0002',
relative_trigger_name = 'trigger-0001'
),
),
schedule.Event(
name='daily-0001',
schedule_type=schedule.EventScheduleType.ABSOLUTE,
repeat_setting=schedule.RepeatSetting(
repeat_type=schedule.RepeatSettingRepeatType.ALWAYS,
options=schedule.RepeatSettingOptions(
begin_day_of_month=1,
end_day_of_month=1,
begin_hour=0,
end_hour=0,
active_days=1,
inactive_days=0,
),
),
options=schedule.EventOptions(
metadata = 'EVENT_0003',
absolute_begin = 1569369600000,
absolute_end = 1569456000000
),
),
schedule.Event(
name='daily-0002',
schedule_type=schedule.EventScheduleType.ABSOLUTE,
repeat_setting=schedule.RepeatSetting(
repeat_type=schedule.RepeatSettingRepeatType.ALWAYS,
options=schedule.RepeatSettingOptions(
begin_day_of_month=1,
end_day_of_month=1,
begin_hour=0,
end_hour=0,
active_days=1,
inactive_days=0,
),
),
options=schedule.EventOptions(
metadata = 'EVENT_0004',
absolute_begin = 1569369600000,
absolute_end = 1569456000000
),
),
schedule.Event(
name='weekly-0001',
schedule_type=schedule.EventScheduleType.ABSOLUTE,
repeat_setting=schedule.RepeatSetting(
repeat_type=schedule.RepeatSettingRepeatType.ALWAYS,
options=schedule.RepeatSettingOptions(
begin_day_of_month=1,
end_day_of_month=1,
begin_hour=0,
end_hour=0,
active_days=1,
inactive_days=0,
),
),
options=schedule.EventOptions(
metadata = 'EVENT_0005',
absolute_begin = 1569888000000,
absolute_end = 1570406400000
),
),
schedule.Event(
name='weekly-0002',
schedule_type=schedule.EventScheduleType.ABSOLUTE,
repeat_setting=schedule.RepeatSetting(
repeat_type=schedule.RepeatSettingRepeatType.ALWAYS,
options=schedule.RepeatSettingOptions(
begin_day_of_month=1,
end_day_of_month=1,
begin_hour=0,
end_hour=0,
active_days=1,
inactive_days=0,
),
),
options=schedule.EventOptions(
metadata = 'EVENT_0006',
absolute_begin = 1569888000000,
absolute_end = 1570406400000
),
),
schedule.Event(
name='monthly-0001',
schedule_type=schedule.EventScheduleType.ABSOLUTE,
repeat_setting=schedule.RepeatSetting(
repeat_type=schedule.RepeatSettingRepeatType.ALWAYS,
options=schedule.RepeatSettingOptions(
begin_day_of_month=1,
end_day_of_month=1,
begin_hour=0,
end_hour=0,
active_days=1,
inactive_days=0,
),
),
options=schedule.EventOptions(
metadata = 'EVENT_0007',
absolute_begin = 1570406400000,
absolute_end = 1575158400000
),
),
schedule.Event(
name='monthly-0002',
schedule_type=schedule.EventScheduleType.ABSOLUTE,
repeat_setting=schedule.RepeatSetting(
repeat_type=schedule.RepeatSettingRepeatType.ALWAYS,
options=schedule.RepeatSettingOptions(
begin_day_of_month=1,
end_day_of_month=1,
begin_hour=0,
end_hour=0,
active_days=1,
inactive_days=0,
),
),
options=schedule.EventOptions(
metadata = 'EVENT_0008',
absolute_begin = 1570406400000,
absolute_end = 1575158400000
),
),
],
)
print(SampleStack().yaml()) # Generate TemplateRepeatSetting
Repeat Setting
There are two types of event durations: absolute and relative.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| repeatType | String Enum enum { “always”, “daily”, “weekly”, “monthly”, “custom” } | ✓ | “always” | ~ 128 chars | Type of repetition
| |||||||||||||
| beginDayOfMonth | int | {repeatType} == “monthly” | ✓* | 1 ~ 31 | Event repeat start date (If the value exceeds the days of the month, it is treated as the last day.) * Required if repeatType is “monthly” | |||||||||||||
| endDayOfMonth | int | {repeatType} == “monthly” | ✓* | 1 ~ 31 | Event repeat end date (If the value exceeds the days of the month, it is treated as the last day.) * Required if repeatType is “monthly” | |||||||||||||
| beginDayOfWeek | String Enum enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ✓* | ~ 128 chars | Repeat start day of event * Required if repeatType is “weekly” | |||||||||||||
| endDayOfWeek | String Enum enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ✓* | ~ 128 chars | Repeat event end day of the week * Required if repeatType is “weekly” | |||||||||||||
| beginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓* | 0 ~ 23 | Event repetition start time (in hours) | |||||||||||||
| endHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓* | 0 ~ 24 | Event repetition end time (in hours) | |||||||||||||
| anchorTimestamp | long | {repeatType} == “custom” | ✓* | Anchor date to start the cycle * Required if repeatType is “custom” | ||||||||||||||
| activeDays | int | {repeatType} == “custom” | ✓* | 1 ~ 2147483646.0 | Number of active days in the cycle * Required if repeatType is “custom” | |||||||||||||
| inactiveDays | int | {repeatType} == “custom” | ✓* | 0 ~ 2147483646.0 | Number of inactive days in the cycle * Required if repeatType is “custom” |
RepeatSchedule
State of repeating schedule
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| repeatCount | int | ✓ | 0 ~ 2147483646 | Number of times to repeat | ||
| currentRepeatStartAt | long | Start date and time of repeating event | ||||
| currentRepeatEndAt | long | End date and time of repeating event | ||||
| lastRepeatEndAt | long | End date and time of last event | ||||
| nextRepeatStartAt | long | Start date and time of next event |
LogSetting
Log Export Settings
Manages log data export settings. This type holds the GS2-Log namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, and debugging.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | GS2-Log namespace GRN to output logs |
TransactionSetting
Transaction settings
Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, Distributor, batch application of script results, and asynchronous acquisition actions via JobQueue enables robust transaction management tailored to game logic.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | Whether to automatically execute issued transactions on the server side | ||
| enableAtomicCommit | bool | {enableAutoRun} == true | ✓* | false | Whether to commit the execution of transactions atomically * Required if enableAutoRun is true | |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | ✓* | false | Whether to execute transactions asynchronously * Required if enableAtomicCommit is true | |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | ✓* | false | Whether to execute the commit processing of the script result asynchronously * Required if transactionUseDistributor is true | |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | ✓* | false | Whether to use GS2-JobQueue to execute the acquire action * Required if enableAtomicCommit is true | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor namespace used for transaction execution | |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | Namespace in GS2-JobQueue used to run the transaction |
GitHubCheckoutSetting
Setup to check out master data from GitHub
| Type | Condition | Required | Default | Value Limits | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| apiKeyId | string | ✓ | ~ 1024 chars | GitHub API key GRN | ||||||||||
| repositoryName | string | ✓ | ~ 1024 chars | Repository Name | ||||||||||
| sourcePath | string | ✓ | ~ 1024 chars | Master data (JSON) file path | ||||||||||
| referenceType | String Enum enum { “commit_hash”, “branch”, “tag” } | ✓ | ~ 128 chars | Source of code
| ||||||||||
| commitHash | string | {referenceType} == “commit_hash” | ✓* | ~ 1024 chars | Commit hash * Required if referenceType is “commit_hash” | |||||||||
| branchName | string | {referenceType} == “branch” | ✓* | ~ 1024 chars | Branch Name * Required if referenceType is “branch” | |||||||||
| tagName | string | {referenceType} == “tag” | ✓* | ~ 1024 chars | Tag Name * Required if referenceType is “tag” |