GS2-Deploy/CDK Reference of GS2-News Entities Namespace Namespace
Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project.
Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.
Therefore, it is necessary to create a namespace before starting to use each service.
Type Require Default Limitation Description name string ✓ ~ 32 chars Namespace Name description string ~ 1024 chars Description logSetting LogSetting Log output settings
GetAttr Type Description Item Namespace Namespace created
Implementation Example
Language:
GS2-Deploy
Python
PHP
Java
TypeScript
C# 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 Type Require Default Limitation Description contents List<Content> ~ 1000 items List of content to include in the view removeContents List<Content> ~ 1000 items List of content not to be included in the view
Content Type Require Default Limitation Description section string ✓ ~ 1024 chars Section content string ✓ ~ 1024 chars Contents Name frontMatter string ✓ ~ 1048576 chars Front Matter
News Type Require Default Limitation Description section string ✓ ~ 1024 chars Section Name content string ✓ ~ 1024 chars Content Name title string ✓ ~ 1024 chars Article Headline scheduleEventId string ~ 1024 chars Event GRN timestamp long ✓ Timestamp frontMatter string ✓ ~ 1024 chars Front Matter
SetCookieRequestEntry Type Require Default Limitation Description key string ✓ ~ 128 chars Key value of the cookie you would like us to set to be able to view the article value string ✓ ~ 1024 chars 記事を閲覧できるようにするために設定してほしい Cookie の値
LogSetting Type Require Default Limitation Description loggingNamespaceId string ✓ ~ 1024 chars Namespace GRN
GitHubCheckoutSetting Type Require Default Limitation Description apiKeyId string ✓ ~ 1024 chars GitHub API key GRN repositoryName string ✓ ~ 1024 chars Repository Name sourcePath string ✓ ~ 1024 chars Source code file path referenceType enum [ “commit_hash”, “branch”, “tag” ] ✓ ~ 128 chars Source of code commitHash string {referenceType} == “commit_hash” ~ 1024 chars Commit hash branchName string {referenceType} == “branch” ~ 1024 chars Branch Name tagName string {referenceType} == “tag” ~ 1024 chars Tag Name