GS2-News GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
name | string | ✓ | | ~ 32文字 | ネームスペースの名前 |
description | string | | | ~ 1024文字 | 説明文 |
logSetting | LogSetting | | | | ログの出力設定 |
GetAttr
実装例
Type: GS2::News::Namespace
Properties:
Name: namespace1
Description: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, news
class SampleStack(Stack):
def __init__(self):
super().__init__()
news.Namespace(
stack=self,
name="namespace-0001",
options=news.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\News\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\News\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.news.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.news.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 news from "@/gs2cdk/news";
class SampleStack extends core.Stack
{
public constructor() {
super();
new news.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.Gs2News.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2News.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
View
Content
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
section | string | ✓ | | ~ 1024文字 | セクション |
content | string | ✓ | | ~ 1024文字 | コンテンツ名 |
frontMatter | string | ✓ | | ~ 1048576文字 | Front Matter |
News
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
section | string | ✓ | | ~ 1024文字 | セクション名 |
content | string | ✓ | | ~ 1024文字 | コンテンツ名 |
title | string | ✓ | | ~ 1024文字 | 記事見出し |
scheduleEventId | string | | | ~ 1024文字 | イベントGRN |
timestamp | long | ✓ | | | タイムスタンプ |
frontMatter | string | ✓ | | ~ 1024文字 | Front Matter |
SetCookieRequestEntry
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
key | string | ✓ | | ~ 128文字 | 記事を閲覧できるようにするために設定してほしい Cookie のキー値 |
value | string | ✓ | | ~ 1024文字 | 記事を閲覧できるようにするために設定してほしい Cookie の値 |
LogSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
loggingNamespaceId | string | ✓ | | ~ 1024文字 | ネームスペースGRN |
GitHubCheckoutSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
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文字 | タグ名 |