API Reference of GS2-Formation SDK Specification of models and API references for GS2-SDK for various programming languages
Model 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 Condition Require Default Limitation Description namespaceId string ✓ ~ 1024 chars Namespace GRN name string ✓ ~ 128 chars Namespace name description string ~ 1024 chars Description transactionSetting TransactionSetting Transaction settings updateMoldScript ScriptSetting Script to run when updating capacity updateFormScript ScriptSetting Script to run when updating a form updatePropertyFormScript ScriptSetting Script to run when updating a property form logSetting LogSetting Log output settings createdAt long ✓ Now Datetime of creation (Unix time unit:milliseconds) updatedAt long ✓ Now Datetime of last update (Unix time unit:milliseconds) revision long 0 ~ 9223372036854775805 Revision
Form Model
This entity represents the form status.
A slot can be defined as an area that can be organized.
In the case of weapons and armor, a slot can be a part such as right hand', left hand’, body', arm’, etc., or it can be an area such as slot', slot’, or `slot’, etc.
In the case of a party, positions such as “vanguard,” “middle guard,” and “rear guard” can be represented as slots.
Type Condition Require Default Limitation Description formModelId string ✓ ~ 1024 chars Form model GRN name string ✓ ~ 128 chars Form model name metadata string ~ 2048 chars metadata slots List<SlotModel> ✓ 1 ~ 10 items List of Slot Model
Form Model Master
This entity represents the form status.
A slot can be defined as an area that can be organized.
In the case of weapons and armor, a slot can be a part such as right hand', left hand’, body', arm’, etc., or it can be an area such as slot', slot’, or `slot’, etc.
In the case of a party, positions such as “vanguard,” “middle guard,” and “rear guard” can be represented as slots.
Type Condition Require Default Limitation Description formModelId string ✓ ~ 1024 chars Form model master GRN name string ✓ ~ 128 chars Form model name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata slots List<SlotModel> ✓ 1 ~ 10 items List of Slot Model createdAt long ✓ Now Datetime of creation (Unix time unit:milliseconds) updatedAt long ✓ Now Datetime of last update (Unix time unit:milliseconds) revision long 0 ~ 9223372036854775805 Revision
MoldModel Area for storing form
If it is a party composition, it is intended to be saved in the form of “fire attribute party” or “water attribute party”.
The number of areas that can be saved can be limited or expanded individually.
Type Condition Require Default Limitation Description moldModelId string ✓ ~ 1024 chars Form storage area GRN name string ✓ ~ 128 chars Form storage area model name metadata string ~ 2048 chars metadata initialMaxCapacity int ✓ 1 ~ 2147483646 Initial capacity to store forms maxCapacity int ✓ 1 ~ 2147483646 Maximum capacity to store forms formModel FormModel ✓
MoldModelMaster Area for storing form master
If it is a party composition, it is intended to be saved in the form of “fire attribute party” or “water attribute party”.
The number of areas that can be saved can be limited or expanded individually.
Type Condition Require Default Limitation Description moldModelId string ✓ ~ 1024 chars Form storage area model master GRN name string ✓ ~ 128 chars Form storage area model name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata initialMaxCapacity int ✓ 1 ~ 2147483646 Initial capacity to store forms maxCapacity int ✓ 1 ~ 2147483646 Maximum capacity to store forms formModelName string ✓ ~ 128 chars Form model name createdAt long ✓ Now Datetime of creation (Unix time unit:milliseconds) updatedAt long ✓ Now Datetime of last update (Unix time unit:milliseconds) revision long 0 ~ 9223372036854775805 Revision
Property Form Model
An entity that represents the composition status.
The difference between Mold / Form is that Mold / Form defines the number of slots and records the composition in each slot,
and Property Form is used to represent compositions that are difficult to determine the number of slots in advance, such as setting skills for owned equipment.
Type Condition Require Default Limitation Description propertyFormModelId string ✓ ~ 1024 chars Property form model GRN name string ✓ ~ 128 chars Property form model name metadata string ~ 2048 chars metadata slots List<SlotModel> ✓ 1 ~ 10 items List of Slot Model
Property Form Model Master
An entity that represents the composition status.
The difference between Mold / Form is that Mold / Form defines the number of slots and records the composition in each slot,
and Property Form is used to represent compositions that are difficult to determine the number of slots in advance, such as setting skills for owned equipment.
Type Condition Require Default Limitation Description propertyFormModelId string ✓ ~ 1024 chars Property Form Master GRN name string ✓ ~ 128 chars Property form model name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata slots List<SlotModel> ✓ 1 ~ 10 items List of Slot Model createdAt long ✓ Now Datetime of creation (Unix time unit:milliseconds) updatedAt long ✓ Now Datetime of last update (Unix time unit:milliseconds) revision long 0 ~ 9223372036854775805 Revision
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.
We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the
The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.
Type Condition Require Default Limitation Description namespaceId string ✓ ~ 1024 chars Currently available form settings GRN settings string ✓ ~ 5242880 chars Master data
Mold Form storage area
An entity that holds information organized by the game player.
Each Mold can hold multiple Forms, and the capacity of how many Forms can be held can be set individually for each Mold.
Type Condition Require Default Limitation Description moldId string ✓ ~ 1024 chars Form storage area GRN name string ✓ ~ 128 chars Form storage area model name userId string ✓ ~ 128 chars User Id capacity int ✓ ~ 2147483646 Current Capacity createdAt long ✓ Now Datetime of creation (Unix time unit:milliseconds) updatedAt long ✓ Now Datetime of last update (Unix time unit:milliseconds) revision long 0 ~ 9223372036854775805 Revision
Form
This entity represents the form status.
A slot can be defined as an area that can be organized.
In the case of weapons and armor, a slot can be a part such as right hand', left hand’, body', arm’, etc., or it can be an area such as slot', slot’, or `slot’, etc.
In the case of a party, positions such as “vanguard,” “middle guard,” and “rear guard” can be represented as slots.
Type Condition Require Default Limitation Description formId string ✓ ~ 1024 chars Form GRN name string ✓ ~ 128 chars Name of the form storage area model index int ✓ ~ 2147483646 Index of form storage area slots List<Slot> ~ 10 items List of Slots createdAt long ✓ Now Datetime of creation (Unix time unit:milliseconds) updatedAt long ✓ Now Datetime of last update (Unix time unit:milliseconds) revision long 0 ~ 9223372036854775805 Revision
Property Form
An entity that represents the composition status.
The difference between Mold / Form is that Mold / Form defines the number of slots and records the composition in each slot,
and Property Form is used to represent compositions that are difficult to determine the number of slots in advance, such as setting skills for owned equipment.
Type Condition Require Default Limitation Description formId string ✓ ~ 1024 chars Property Form GRN userId string ✓ ~ 128 chars User Id name string ✓ ~ 128 chars Property form name propertyId string ✓ ~ 1024 chars Property Id slots List<Slot> ~ 10 items List of Slots createdAt long ✓ Now Datetime of creation (Unix time unit:milliseconds) updatedAt long ✓ Now Datetime of last update (Unix time unit:milliseconds) revision long 0 ~ 9223372036854775805 Revision
Slot Slot
Type Condition Require Default Limitation Description name string ✓ ~ 128 chars Slot model name propertyId string ~ 1024 chars Property ID metadata string ~ 1024 chars metadata
SlotModel Slot Model
Type Condition Require Default Limitation Description name string ✓ ~ 128 chars Slot model name propertyRegex string ✓ “.*” ~ 512 chars Regular expressions for values that can be set as properties metadata string ~ 512 chars metadata
SlotWithSignature Signature Slot
Type Condition Require Default Limitation Description name string ✓ ~ 128 chars Slot model name propertyType enum { ✓ ~ 128 chars Property Type body string ~ 1048576 chars payload signature string ~ 1024 chars Signature that proves ownership of the resource for the property ID metadata string ~ 1024 chars metadata
Definition of enumeration type to be specified for propertyType Enumerator String Definition Description gs2_inventory GS2-Inventory::ItemSet gs2_simple_inventory GS2-Inventory::SimpleItem gs2_dictionary GS2-Dictionary::Entry
AcquireAction Acquire Action
Type Condition Require Default Limitation Description action enum {"Gs2AdReward:AcquirePointByUserId" ,"Gs2Dictionary:AddEntriesByUserId" ,"Gs2Enchant:ReDrawBalanceParameterStatusByUserId" ,"Gs2Enchant:SetBalanceParameterStatusByUserId" ,"Gs2Enchant:ReDrawRarityParameterStatusByUserId" ,"Gs2Enchant:AddRarityParameterStatusByUserId" ,"Gs2Enchant:SetRarityParameterStatusByUserId" ,"Gs2Enhance:DirectEnhanceByUserId" ,"Gs2Enhance:UnleashByUserId" ,"Gs2Enhance:CreateProgressByUserId" ,"Gs2Exchange:ExchangeByUserId" ,"Gs2Exchange:IncrementalExchangeByUserId" ,"Gs2Exchange:CreateAwaitByUserId" ,"Gs2Exchange:AcquireForceByUserId" ,"Gs2Exchange:SkipByUserId" ,"Gs2Experience:AddExperienceByUserId" ,"Gs2Experience:SetExperienceByUserId" ,"Gs2Experience:AddRankCapByUserId" ,"Gs2Experience:SetRankCapByUserId" ,"Gs2Experience:MultiplyAcquireActionsByUserId" ,"Gs2Formation:AddMoldCapacityByUserId" ,"Gs2Formation:SetMoldCapacityByUserId" ,"Gs2Formation:AcquireActionsToFormProperties" ,"Gs2Formation:SetFormByUserId" ,"Gs2Formation:AcquireActionsToPropertyFormProperties" ,"Gs2Friend:UpdateProfileByUserId" ,"Gs2Grade:AddGradeByUserId" ,"Gs2Grade:ApplyRankCapByUserId" ,"Gs2Grade:MultiplyAcquireActionsByUserId" ,"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName" ,"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName" ,"Gs2Idle:IncreaseMaximumIdleMinutesByUserId" ,"Gs2Idle:SetMaximumIdleMinutesByUserId" ,"Gs2Idle:ReceiveByUserId" ,"Gs2Inbox:SendMessageByUserId" ,"Gs2Inventory:AddCapacityByUserId" ,"Gs2Inventory:SetCapacityByUserId" ,"Gs2Inventory:AcquireItemSetByUserId" ,"Gs2Inventory:AcquireItemSetWithGradeByUserId" ,"Gs2Inventory:AddReferenceOfByUserId" ,"Gs2Inventory:DeleteReferenceOfByUserId" ,"Gs2Inventory:AcquireSimpleItemsByUserId" ,"Gs2Inventory:SetSimpleItemsByUserId" ,"Gs2Inventory:AcquireBigItemByUserId" ,"Gs2Inventory:SetBigItemByUserId" ,"Gs2JobQueue:PushByUserId" ,"Gs2Limit:CountDownByUserId" ,"Gs2Limit:DeleteCounterByUserId" ,"Gs2LoginReward:DeleteReceiveStatusByUserId" ,"Gs2LoginReward:UnmarkReceivedByUserId" ,"Gs2Lottery:DrawByUserId" ,"Gs2Lottery:ResetBoxByUserId" ,"Gs2Mission:RevertReceiveByUserId" ,"Gs2Mission:IncreaseCounterByUserId" ,"Gs2Mission:SetCounterByUserId" ,"Gs2Money:DepositByUserId" ,"Gs2Money:RevertRecordReceipt" ,"Gs2Money2:DepositByUserId" ,"Gs2Quest:CreateProgressByUserId" ,"Gs2Schedule:TriggerByUserId" ,"Gs2Script:InvokeScript" ,"Gs2SerialKey:RevertUseByUserId" ,"Gs2SerialKey:IssueOnce" ,"Gs2Showcase:DecrementPurchaseCountByUserId" ,"Gs2Showcase:ForceReDrawByUserId" ,"Gs2SkillTree:MarkReleaseByUserId" ,"Gs2Stamina:RecoverStaminaByUserId" ,"Gs2Stamina:RaiseMaxValueByUserId" ,"Gs2Stamina:SetMaxValueByUserId" ,"Gs2Stamina:SetRecoverIntervalByUserId" ,"Gs2Stamina:SetRecoverValueByUserId" ,"Gs2StateMachine:StartStateMachineByUserId" , ✓ ~ 128 chars Types of actions to be performed in the acquire action request string ✓ ~ 524288 chars JSON of request
Config Configration
Set values to be applied to transaction variables
Type Condition Require Default Limitation Description key string ✓ ~ 64 chars Name value string ~ 51200 chars Value
VerifyActionResult Verify action execution result
Type Condition Require Default Limitation Description action enum { ✓ ~ 128 chars Types of actions to be performed in the verify task verifyRequest string ✓ ~ 524288 chars JSON of request statusCode int ~ 999 Status code verifyResult string ~ 1048576 chars Result payload
Definition of enumeration type to be specified for action Enumerator String Definition Description
ConsumeActionResult Consume action execution result
Type Condition Require Default Limitation Description action enum { ✓ ~ 128 chars Types of actions to be performed in the consume action consumeRequest string ✓ ~ 524288 chars JSON of request statusCode int ~ 999 Status code consumeResult string ~ 1048576 chars Result payload
Definition of enumeration type to be specified for action Enumerator String Definition Description
AcquireActionResult Acquire action execution result
Type Condition Require Default Limitation Description action enum { ✓ ~ 128 chars Types of actions to be performed in the acquire action acquireRequest string ✓ ~ 524288 chars JSON of request statusCode int ~ 999 Status code acquireResult string ~ 1048576 chars Result payload
Definition of enumeration type to be specified for action Enumerator String Definition Description
TransactionResult Transaction execution results
Transaction execution results executed using server-side transaction auto-execution functionality
Type Condition Require Default Limitation Description transactionId string ✓ 36 ~ 36 chars Transaction ID verifyResults List<VerifyActionResult> ~ 10 items List of verify action execution results consumeResults List<ConsumeActionResult> [] ~ 10 items List of consume action execution results acquireResults List<AcquireActionResult> [] ~ 100 items List of acquire action execution results hasError bool ✓ false Whether an error occurred during transaction execution
GitHubCheckoutSetting Setup to check out master data from GitHub
Type Condition 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 { ✓ ~ 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
Definition of enumeration type to be specified for referenceType Enumerator String Definition Description commit_hash Commit hash branch Branch tag Tag
ScriptSetting Script settings
In GS2, you can associate custom scripts with microservice events and execute them.
This model holds the settings for triggering script execution.
There are two main ways to execute a script: synchronous execution and asynchronous execution.
Synchronous execution blocks processing until the script has finished executing.
Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API.
On the other hand, asynchronous execution does not block processing until the script has finished executing.
Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API.
However, asynchronous execution does not block processing until the script has finished executing, so it is generally recommended to use asynchronous execution.
There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge.
By using Amazon EventBridge, you can write processing in languages other than Lua.
Type Condition Require Default Limitation Description triggerScriptId string ~ 1024 chars Script GRN doneTriggerTargetType enum { ✓ “none” ~ 128 chars Notification of Completion doneTriggerScriptId string {doneTriggerTargetType} == “gs2_script” ~ 1024 chars Script GRN doneTriggerQueueNamespaceId string {doneTriggerTargetType} == “gs2_script” ~ 1024 chars Namespace GRN
Definition of enumeration type to be specified for doneTriggerTargetType Enumerator String Definition Description none None gs2_script GS2-Script aws Amazon EventBridge
LogSetting Log setting
This type manages log output settings.
This type holds the identifier of the log namespace used to output log data.
The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data.
Through this setting, API request and response log data under this namespace will be output to the target GS2-Log.
GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.
Type Condition Require Default Limitation Description loggingNamespaceId string ✓ ~ 1024 chars Namespace GRN
TransactionSetting Transaction settings
Type Condition Require Default Limitation 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 transactionUseDistributor bool {enableAtomicCommit} == true ✓ false Whether to execute transactions asynchronously acquireActionUseJobQueue bool {enableAtomicCommit} == true ✓ false Whether to use GS2-JobQueue to execute the acquire action 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
Methods describeNamespaces Get list of namespaces
Request Type Condition Require Default Limitation Description pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired
Result Type Description items List<Namespace> List of Namespace nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribeNamespaces (
& formation . DescribeNamespacesRequest {
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribeNamespacesRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeNamespaces (
( new DescribeNamespacesRequest ())
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribeNamespacesRequest ;
import io.gs2.formation.result.DescribeNamespacesResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribeNamespacesResult result = client . describeNamespaces (
new DescribeNamespacesRequest ()
. withPageToken ( null )
. withLimit ( null )
);
List < Namespace > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribeNamespacesRequest ;
using Gs2.Gs2Formation.Result.DescribeNamespacesResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribeNamespacesResult > asyncResult = null ;
yield return client . DescribeNamespaces (
new Gs2 . Gs2Formation . Request . DescribeNamespacesRequest ()
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describeNamespaces (
new Gs2Formation . DescribeNamespacesRequest ()
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_namespaces (
formation . DescribeNamespacesRequest ()
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_namespaces ({
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_namespaces_async ({
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; createNamespace Create a new namespace
Request Type Condition Require Default Limitation Description name string ✓ ~ 128 chars Namespace name description string ~ 1024 chars Description transactionSetting TransactionSetting Transaction settings updateMoldScript ScriptSetting Script to run when updating capacity updateFormScript ScriptSetting Script to run when updating a form updatePropertyFormScript ScriptSetting Script to run when updating a property form logSetting LogSetting Log output settings
Result Type Description item Namespace Namespace created
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . CreateNamespace (
& formation . CreateNamespaceRequest {
Name : pointy . String ( "namespace-0001" ),
Description : nil ,
TransactionSetting : & formation . TransactionSetting {
EnableAutoRun : pointy . Bool ( false ),
QueueNamespaceId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" ),
KeyId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001" ),
},
UpdateMoldScript : nil ,
UpdateFormScript : nil ,
UpdatePropertyFormScript : nil ,
LogSetting : & formation . LogSetting {
LoggingNamespaceId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ),
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\CreateNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createNamespace (
( new CreateNamespaceRequest ())
-> withName ( "namespace-0001" )
-> withDescription ( null )
-> withTransactionSetting (( new \Gs2\Formation\Model\TransactionSetting ())
-> withEnableAutoRun ( False )
-> withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" )
-> withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001" ))
-> withUpdateMoldScript ( null )
-> withUpdateFormScript ( null )
-> withUpdatePropertyFormScript ( null )
-> withLogSetting (( new \Gs2\Formation\Model\LogSetting ())
-> withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ))
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.CreateNamespaceRequest ;
import io.gs2.formation.result.CreateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
CreateNamespaceResult result = client . createNamespace (
new CreateNamespaceRequest ()
. withName ( "namespace-0001" )
. withDescription ( null )
. withTransactionSetting ( new io . gs2 . formation . model . TransactionSetting ()
. withEnableAutoRun ( false )
. withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" )
. withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001" ))
. withUpdateMoldScript ( null )
. withUpdateFormScript ( null )
. withUpdatePropertyFormScript ( null )
. withLogSetting ( new io . gs2 . formation . model . LogSetting ()
. withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ))
);
Namespace item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.CreateNamespaceRequest ;
using Gs2.Gs2Formation.Result.CreateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . CreateNamespaceResult > asyncResult = null ;
yield return client . CreateNamespace (
new Gs2 . Gs2Formation . Request . CreateNamespaceRequest ()
. WithName ( "namespace-0001" )
. WithDescription ( null )
. WithTransactionSetting ( new Gs2 . Gs2Formation . Model . TransactionSetting ()
. WithEnableAutoRun ( false )
. WithQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" )
. WithKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001" ))
. WithUpdateMoldScript ( null )
. WithUpdateFormScript ( null )
. WithUpdatePropertyFormScript ( null )
. WithLogSetting ( new Gs2 . Gs2Formation . Model . LogSetting ()
. WithLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" )),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . createNamespace (
new Gs2Formation . CreateNamespaceRequest ()
. withName ( "namespace-0001" )
. withDescription ( null )
. withTransactionSetting ( new Gs2Formation . model . TransactionSetting ()
. withEnableAutoRun ( false )
. withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" )
. withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001" ))
. withUpdateMoldScript ( null )
. withUpdateFormScript ( null )
. withUpdatePropertyFormScript ( null )
. withLogSetting ( new Gs2Formation . model . LogSetting ()
. withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ))
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . create_namespace (
formation . CreateNamespaceRequest ()
. with_name ( 'namespace-0001' )
. with_description ( None )
. with_transaction_setting (
formation . TransactionSetting ()
. with_enable_auto_run ( False )
. with_queue_namespace_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001' )
. with_key_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001' ))
. with_update_mold_script ( None )
. with_update_form_script ( None )
. with_update_property_form_script ( None )
. with_log_setting (
formation . LogSetting ()
. with_logging_namespace_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001' ))
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.create_namespace ({
name = "namespace-0001" ,
description = nil ,
transactionSetting = {
enableAutoRun = false ,
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" ,
keyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001" ,
},
updateMoldScript = nil ,
updateFormScript = nil ,
updatePropertyFormScript = nil ,
logSetting = {
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ,
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.create_namespace_async ({
name = "namespace-0001" ,
description = nil ,
transactionSetting = {
enableAutoRun = false ,
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" ,
keyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001" ,
},
updateMoldScript = nil ,
updateFormScript = nil ,
updatePropertyFormScript = nil ,
logSetting = {
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ,
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; getNamespaceStatus Get namespace status
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name
Result Type Description status string
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetNamespaceStatus (
& formation . GetNamespaceStatusRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
status := result . Status use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetNamespaceStatusRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getNamespaceStatus (
( new GetNamespaceStatusRequest ())
-> withNamespaceName ( "namespace-0001" )
);
$status = $result -> getStatus ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetNamespaceStatusRequest ;
import io.gs2.formation.result.GetNamespaceStatusResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetNamespaceStatusResult result = client . getNamespaceStatus (
new GetNamespaceStatusRequest ()
. withNamespaceName ( "namespace-0001" )
);
String status = result . getStatus ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetNamespaceStatusRequest ;
using Gs2.Gs2Formation.Result.GetNamespaceStatusResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetNamespaceStatusResult > asyncResult = null ;
yield return client . GetNamespaceStatus (
new Gs2 . Gs2Formation . Request . GetNamespaceStatusRequest ()
. WithNamespaceName ( "namespace-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var status = result . Status ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getNamespaceStatus (
new Gs2Formation . GetNamespaceStatusRequest ()
. withNamespaceName ( "namespace-0001" )
);
const status = result . getStatus ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_namespace_status (
formation . GetNamespaceStatusRequest ()
. with_namespace_name ( 'namespace-0001' )
)
status = result . status
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_namespace_status ({
namespaceName = "namespace-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
status = result.status ; client = gs2 ( 'formation' )
api_result_handler = client.get_namespace_status_async ({
namespaceName = "namespace-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
status = result.status ; getNamespace Get namespace
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetNamespace (
& formation . GetNamespaceRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getNamespace (
( new GetNamespaceRequest ())
-> withNamespaceName ( "namespace-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetNamespaceRequest ;
import io.gs2.formation.result.GetNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetNamespaceResult result = client . getNamespace (
new GetNamespaceRequest ()
. withNamespaceName ( "namespace-0001" )
);
Namespace item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetNamespaceRequest ;
using Gs2.Gs2Formation.Result.GetNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetNamespaceResult > asyncResult = null ;
yield return client . GetNamespace (
new Gs2 . Gs2Formation . Request . GetNamespaceRequest ()
. WithNamespaceName ( "namespace-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getNamespace (
new Gs2Formation . GetNamespaceRequest ()
. withNamespaceName ( "namespace-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_namespace (
formation . GetNamespaceRequest ()
. with_namespace_name ( 'namespace-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_namespace ({
namespaceName = "namespace-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.get_namespace_async ({
namespaceName = "namespace-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; updateNamespace Update namespace
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name description string ~ 1024 chars Description transactionSetting TransactionSetting Transaction settings updateMoldScript ScriptSetting Script to run when updating capacity updateFormScript ScriptSetting Script to run when updating a form updatePropertyFormScript ScriptSetting Script to run when updating a property form logSetting LogSetting Log output settings
Result Type Description item Namespace Updated namespace
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . UpdateNamespace (
& formation . UpdateNamespaceRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
Description : pointy . String ( "description1" ),
TransactionSetting : & formation . TransactionSetting {
EnableAutoRun : pointy . Bool ( false ),
QueueNamespaceId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" ),
KeyId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0002" ),
},
UpdateMoldScript : nil ,
UpdateFormScript : nil ,
UpdatePropertyFormScript : nil ,
LogSetting : & formation . LogSetting {
LoggingNamespaceId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ),
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\UpdateNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateNamespace (
( new UpdateNamespaceRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withDescription ( "description1" )
-> withTransactionSetting (( new \Gs2\Formation\Model\TransactionSetting ())
-> withEnableAutoRun ( False )
-> withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" )
-> withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0002" ))
-> withUpdateMoldScript ( null )
-> withUpdateFormScript ( null )
-> withUpdatePropertyFormScript ( null )
-> withLogSetting (( new \Gs2\Formation\Model\LogSetting ())
-> withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ))
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.UpdateNamespaceRequest ;
import io.gs2.formation.result.UpdateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
UpdateNamespaceResult result = client . updateNamespace (
new UpdateNamespaceRequest ()
. withNamespaceName ( "namespace-0001" )
. withDescription ( "description1" )
. withTransactionSetting ( new io . gs2 . formation . model . TransactionSetting ()
. withEnableAutoRun ( false )
. withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" )
. withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0002" ))
. withUpdateMoldScript ( null )
. withUpdateFormScript ( null )
. withUpdatePropertyFormScript ( null )
. withLogSetting ( new io . gs2 . formation . model . LogSetting ()
. withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ))
);
Namespace item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.UpdateNamespaceRequest ;
using Gs2.Gs2Formation.Result.UpdateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . UpdateNamespaceResult > asyncResult = null ;
yield return client . UpdateNamespace (
new Gs2 . Gs2Formation . Request . UpdateNamespaceRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithDescription ( "description1" )
. WithTransactionSetting ( new Gs2 . Gs2Formation . Model . TransactionSetting ()
. WithEnableAutoRun ( false )
. WithQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" )
. WithKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0002" ))
. WithUpdateMoldScript ( null )
. WithUpdateFormScript ( null )
. WithUpdatePropertyFormScript ( null )
. WithLogSetting ( new Gs2 . Gs2Formation . Model . LogSetting ()
. WithLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" )),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . updateNamespace (
new Gs2Formation . UpdateNamespaceRequest ()
. withNamespaceName ( "namespace-0001" )
. withDescription ( "description1" )
. withTransactionSetting ( new Gs2Formation . model . TransactionSetting ()
. withEnableAutoRun ( false )
. withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" )
. withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0002" ))
. withUpdateMoldScript ( null )
. withUpdateFormScript ( null )
. withUpdatePropertyFormScript ( null )
. withLogSetting ( new Gs2Formation . model . LogSetting ()
. withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ))
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . update_namespace (
formation . UpdateNamespaceRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_description ( 'description1' )
. with_transaction_setting (
formation . TransactionSetting ()
. with_enable_auto_run ( False )
. with_queue_namespace_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002' )
. with_key_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0002' ))
. with_update_mold_script ( None )
. with_update_form_script ( None )
. with_update_property_form_script ( None )
. with_log_setting (
formation . LogSetting ()
. with_logging_namespace_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001' ))
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.update_namespace ({
namespaceName = "namespace-0001" ,
description = "description1" ,
transactionSetting = {
enableAutoRun = false ,
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" ,
keyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0002" ,
},
updateMoldScript = nil ,
updateFormScript = nil ,
updatePropertyFormScript = nil ,
logSetting = {
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ,
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.update_namespace_async ({
namespaceName = "namespace-0001" ,
description = "description1" ,
transactionSetting = {
enableAutoRun = false ,
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" ,
keyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0002" ,
},
updateMoldScript = nil ,
updateFormScript = nil ,
updatePropertyFormScript = nil ,
logSetting = {
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001" ,
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; deleteNamespace Delete namespace
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name
Result Type Description item Namespace Deleted namespace
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeleteNamespace (
& formation . DeleteNamespaceRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeleteNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteNamespace (
( new DeleteNamespaceRequest ())
-> withNamespaceName ( "namespace-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeleteNamespaceRequest ;
import io.gs2.formation.result.DeleteNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeleteNamespaceResult result = client . deleteNamespace (
new DeleteNamespaceRequest ()
. withNamespaceName ( "namespace-0001" )
);
Namespace item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeleteNamespaceRequest ;
using Gs2.Gs2Formation.Result.DeleteNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeleteNamespaceResult > asyncResult = null ;
yield return client . DeleteNamespace (
new Gs2 . Gs2Formation . Request . DeleteNamespaceRequest ()
. WithNamespaceName ( "namespace-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deleteNamespace (
new Gs2Formation . DeleteNamespaceRequest ()
. withNamespaceName ( "namespace-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_namespace (
formation . DeleteNamespaceRequest ()
. with_namespace_name ( 'namespace-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_namespace ({
namespaceName = "namespace-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.delete_namespace_async ({
namespaceName = "namespace-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; getServiceVersion Get version of microservice
Request Type Condition Require Default Limitation Description
Result Type Description item string Version
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetServiceVersion (
& formation . GetServiceVersionRequest {
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetServiceVersionRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getServiceVersion (
( new GetServiceVersionRequest ())
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetServiceVersionRequest ;
import io.gs2.formation.result.GetServiceVersionResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetServiceVersionResult result = client . getServiceVersion (
new GetServiceVersionRequest ()
);
String item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetServiceVersionRequest ;
using Gs2.Gs2Formation.Result.GetServiceVersionResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetServiceVersionResult > asyncResult = null ;
yield return client . GetServiceVersion (
new Gs2 . Gs2Formation . Request . GetServiceVersionRequest (),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getServiceVersion (
new Gs2Formation . GetServiceVersionRequest ()
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_service_version (
formation . GetServiceVersionRequest ()
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_service_version ({
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.get_service_version_async ({
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; dumpUserDataByUserId Get dump data of the data associated with the specified user ID
Request Type Condition Require Default Limitation Description userId string ✓ ~ 128 chars User Id timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DumpUserDataByUserId (
& formation . DumpUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
} use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DumpUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> dumpUserDataByUserId (
( new DumpUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DumpUserDataByUserIdRequest ;
import io.gs2.formation.result.DumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DumpUserDataByUserIdResult result = client . dumpUserDataByUserId (
new DumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DumpUserDataByUserIdRequest ;
using Gs2.Gs2Formation.Result.DumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DumpUserDataByUserIdResult > asyncResult = null ;
yield return client . DumpUserDataByUserId (
new Gs2 . Gs2Formation . Request . DumpUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . dumpUserDataByUserId (
new Gs2Formation . DumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . dump_user_data_by_user_id (
formation . DumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.dump_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result client = gs2 ( 'formation' )
api_result_handler = client.dump_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result checkDumpUserDataByUserId Check if the dump of the data associated with the specified user ID is complete
Request Type Condition Require Default Limitation Description userId string ✓ ~ 128 chars User Id timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description url string URL of output data
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . CheckDumpUserDataByUserId (
& formation . CheckDumpUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
url := result . Url use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\CheckDumpUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> checkDumpUserDataByUserId (
( new CheckDumpUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
$url = $result -> getUrl ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.CheckDumpUserDataByUserIdRequest ;
import io.gs2.formation.result.CheckDumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
CheckDumpUserDataByUserIdResult result = client . checkDumpUserDataByUserId (
new CheckDumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
String url = result . getUrl ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.CheckDumpUserDataByUserIdRequest ;
using Gs2.Gs2Formation.Result.CheckDumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . CheckDumpUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckDumpUserDataByUserId (
new Gs2 . Gs2Formation . Request . CheckDumpUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var url = result . Url ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . checkDumpUserDataByUserId (
new Gs2Formation . CheckDumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
const url = result . getUrl ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . check_dump_user_data_by_user_id (
formation . CheckDumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
url = result . url
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.check_dump_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
url = result.url ; client = gs2 ( 'formation' )
api_result_handler = client.check_dump_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
url = result.url ; cleanUserDataByUserId Get clean data of the data associated with the specified user ID
Request Type Condition Require Default Limitation Description userId string ✓ ~ 128 chars User Id timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . CleanUserDataByUserId (
& formation . CleanUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
} use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\CleanUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> cleanUserDataByUserId (
( new CleanUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.CleanUserDataByUserIdRequest ;
import io.gs2.formation.result.CleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
CleanUserDataByUserIdResult result = client . cleanUserDataByUserId (
new CleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.CleanUserDataByUserIdRequest ;
using Gs2.Gs2Formation.Result.CleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . CleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CleanUserDataByUserId (
new Gs2 . Gs2Formation . Request . CleanUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . cleanUserDataByUserId (
new Gs2Formation . CleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . clean_user_data_by_user_id (
formation . CleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.clean_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result client = gs2 ( 'formation' )
api_result_handler = client.clean_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result checkCleanUserDataByUserId Check if the clean of the data associated with the specified user ID is complete
Request Type Condition Require Default Limitation Description userId string ✓ ~ 128 chars User Id timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . CheckCleanUserDataByUserId (
& formation . CheckCleanUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
} use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\CheckCleanUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> checkCleanUserDataByUserId (
( new CheckCleanUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.CheckCleanUserDataByUserIdRequest ;
import io.gs2.formation.result.CheckCleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
CheckCleanUserDataByUserIdResult result = client . checkCleanUserDataByUserId (
new CheckCleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.CheckCleanUserDataByUserIdRequest ;
using Gs2.Gs2Formation.Result.CheckCleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . CheckCleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckCleanUserDataByUserId (
new Gs2 . Gs2Formation . Request . CheckCleanUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . checkCleanUserDataByUserId (
new Gs2Formation . CheckCleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . check_clean_user_data_by_user_id (
formation . CheckCleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.check_clean_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result client = gs2 ( 'formation' )
api_result_handler = client.check_clean_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result prepareImportUserDataByUserId Start importing data associated with the specified user ID
Request Type Condition Require Default Limitation Description userId string ✓ ~ 128 chars User Id timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description uploadToken string Token used to reflect results after upload uploadUrl string URL used to upload user data
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . PrepareImportUserDataByUserId (
& formation . PrepareImportUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
uploadToken := result . UploadToken
uploadUrl := result . UploadUrl use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\PrepareImportUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> prepareImportUserDataByUserId (
( new PrepareImportUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
$uploadToken = $result -> getUploadToken ();
$uploadUrl = $result -> getUploadUrl ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.PrepareImportUserDataByUserIdRequest ;
import io.gs2.formation.result.PrepareImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
PrepareImportUserDataByUserIdResult result = client . prepareImportUserDataByUserId (
new PrepareImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
String uploadToken = result . getUploadToken ();
String uploadUrl = result . getUploadUrl ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.PrepareImportUserDataByUserIdRequest ;
using Gs2.Gs2Formation.Result.PrepareImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . PrepareImportUserDataByUserIdResult > asyncResult = null ;
yield return client . PrepareImportUserDataByUserId (
new Gs2 . Gs2Formation . Request . PrepareImportUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var uploadToken = result . UploadToken ;
var uploadUrl = result . UploadUrl ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . prepareImportUserDataByUserId (
new Gs2Formation . PrepareImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
const uploadToken = result . getUploadToken ();
const uploadUrl = result . getUploadUrl ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . prepare_import_user_data_by_user_id (
formation . PrepareImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
upload_token = result . upload_token
upload_url = result . upload_url
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.prepare_import_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
uploadToken = result.uploadToken ;
uploadUrl = result.uploadUrl ; client = gs2 ( 'formation' )
api_result_handler = client.prepare_import_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
uploadToken = result.uploadToken ;
uploadUrl = result.uploadUrl ; importUserDataByUserId Start importing data associated with the specified user ID
Request Type Condition Require Default Limitation Description userId string ✓ ~ 128 chars User Id uploadToken string ✓ ~ 1024 chars Token received in preparation for upload timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . ImportUserDataByUserId (
& formation . ImportUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
UploadToken : pointy . String ( "upload-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
} use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\ImportUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> importUserDataByUserId (
( new ImportUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withUploadToken ( "upload-0001" )
-> withTimeOffsetToken ( null )
);
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.ImportUserDataByUserIdRequest ;
import io.gs2.formation.result.ImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
ImportUserDataByUserIdResult result = client . importUserDataByUserId (
new ImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
. withTimeOffsetToken ( null )
);
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.ImportUserDataByUserIdRequest ;
using Gs2.Gs2Formation.Result.ImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . ImportUserDataByUserIdResult > asyncResult = null ;
yield return client . ImportUserDataByUserId (
new Gs2 . Gs2Formation . Request . ImportUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithUploadToken ( "upload-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . importUserDataByUserId (
new Gs2Formation . ImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . import_user_data_by_user_id (
formation . ImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_upload_token ( 'upload-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.import_user_data_by_user_id ({
userId = "user-0001" ,
uploadToken = "upload-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result client = gs2 ( 'formation' )
api_result_handler = client.import_user_data_by_user_id_async ({
userId = "user-0001" ,
uploadToken = "upload-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result checkImportUserDataByUserId Check if the import of the data associated with the specified user ID is complete
Request Type Condition Require Default Limitation Description userId string ✓ ~ 128 chars User Id uploadToken string ✓ ~ 1024 chars Token received in preparation for upload timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description url string URL of log data
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . CheckImportUserDataByUserId (
& formation . CheckImportUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
UploadToken : pointy . String ( "upload-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
url := result . Url use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\CheckImportUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> checkImportUserDataByUserId (
( new CheckImportUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withUploadToken ( "upload-0001" )
-> withTimeOffsetToken ( null )
);
$url = $result -> getUrl ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.CheckImportUserDataByUserIdRequest ;
import io.gs2.formation.result.CheckImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
CheckImportUserDataByUserIdResult result = client . checkImportUserDataByUserId (
new CheckImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
. withTimeOffsetToken ( null )
);
String url = result . getUrl ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.CheckImportUserDataByUserIdRequest ;
using Gs2.Gs2Formation.Result.CheckImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . CheckImportUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckImportUserDataByUserId (
new Gs2 . Gs2Formation . Request . CheckImportUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithUploadToken ( "upload-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var url = result . Url ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . checkImportUserDataByUserId (
new Gs2Formation . CheckImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
. withTimeOffsetToken ( null )
);
const url = result . getUrl ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . check_import_user_data_by_user_id (
formation . CheckImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_upload_token ( 'upload-0001' )
. with_time_offset_token ( None )
)
url = result . url
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.check_import_user_data_by_user_id ({
userId = "user-0001" ,
uploadToken = "upload-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
url = result.url ; client = gs2 ( 'formation' )
api_result_handler = client.check_import_user_data_by_user_id_async ({
userId = "user-0001" ,
uploadToken = "upload-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
url = result.url ; Get Form
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name moldModelName string ✓ ~ 128 chars Form storage area model name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetFormModel (
& formation . GetFormModelRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetFormModelRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getFormModel (
( new GetFormModelRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withMoldModelName ( "mold-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetFormModelRequest ;
import io.gs2.formation.result.GetFormModelResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetFormModelResult result = client . getFormModel (
new GetFormModelRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
);
FormModel item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetFormModelRequest ;
using Gs2.Gs2Formation.Result.GetFormModelResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetFormModelResult > asyncResult = null ;
yield return client . GetFormModel (
new Gs2 . Gs2Formation . Request . GetFormModelRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithMoldModelName ( "mold-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getFormModel (
new Gs2Formation . GetFormModelRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_form_model (
formation . GetFormModelRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_mold_model_name ( 'mold-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_form_model ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.get_form_model_async ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired
Result Type Description items List<FormModelMaster> List of Form Model Master nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribeFormModelMasters (
& formation . DescribeFormModelMastersRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribeFormModelMastersRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeFormModelMasters (
( new DescribeFormModelMastersRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribeFormModelMastersRequest ;
import io.gs2.formation.result.DescribeFormModelMastersResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribeFormModelMastersResult result = client . describeFormModelMasters (
new DescribeFormModelMastersRequest ()
. withNamespaceName ( "namespace-0001" )
. withPageToken ( null )
. withLimit ( null )
);
List < FormModelMaster > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribeFormModelMastersRequest ;
using Gs2.Gs2Formation.Result.DescribeFormModelMastersResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribeFormModelMastersResult > asyncResult = null ;
yield return client . DescribeFormModelMasters (
new Gs2 . Gs2Formation . Request . DescribeFormModelMastersRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describeFormModelMasters (
new Gs2Formation . DescribeFormModelMastersRequest ()
. withNamespaceName ( "namespace-0001" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_form_model_masters (
formation . DescribeFormModelMastersRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_form_model_masters ({
namespaceName = "namespace-0001" ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_form_model_masters_async ({
namespaceName = "namespace-0001" ,
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; Create new form model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name name string ✓ ~ 128 chars Form model name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata slots List<SlotModel> ✓ 1 ~ 10 items List of Slot Model
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . CreateFormModelMaster (
& formation . CreateFormModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
Name : pointy . String ( "form-0001" ),
Description : nil ,
Metadata : nil ,
Slots : [] formation . SlotModel {
formation . SlotModel {
Name : pointy . String ( "slot-0001" ),
PropertyRegex : pointy . String ( ".*" ),
},
formation . SlotModel {
Name : pointy . String ( "slot-0002" ),
PropertyRegex : pointy . String ( ".*" ),
Metadata : pointy . String ( "METADATA_0002" ),
},
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\CreateFormModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createFormModelMaster (
( new CreateFormModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withName ( "form-0001" )
-> withDescription ( null )
-> withMetadata ( null )
-> withSlots ([
( new \Gs2\Formation\Model\SlotModel ())
-> withName ( "slot-0001" )
-> withPropertyRegex ( ".*" ),
( new \Gs2\Formation\Model\SlotModel ())
-> withName ( "slot-0002" )
-> withPropertyRegex ( ".*" )
-> withMetadata ( "METADATA_0002" ),
])
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.CreateFormModelMasterRequest ;
import io.gs2.formation.result.CreateFormModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
CreateFormModelMasterResult result = client . createFormModelMaster (
new CreateFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withName ( "form-0001" )
. withDescription ( null )
. withMetadata ( null )
. withSlots ( Arrays . asList (
new io . gs2 . formation . model . SlotModel ()
. withName ( "slot-0001" )
. withPropertyRegex ( ".*" ),
new io . gs2 . formation . model . SlotModel ()
. withName ( "slot-0002" )
. withPropertyRegex ( ".*" )
. withMetadata ( "METADATA_0002" )
))
);
FormModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.CreateFormModelMasterRequest ;
using Gs2.Gs2Formation.Result.CreateFormModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . CreateFormModelMasterResult > asyncResult = null ;
yield return client . CreateFormModelMaster (
new Gs2 . Gs2Formation . Request . CreateFormModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithName ( "form-0001" )
. WithDescription ( null )
. WithMetadata ( null )
. WithSlots ( new Gs2 . Gs2Formation . Model . SlotModel [] {
new Gs2 . Gs2Formation . Model . SlotModel ()
. WithName ( "slot-0001" )
. WithPropertyRegex ( ".*" ),
new Gs2 . Gs2Formation . Model . SlotModel ()
. WithName ( "slot-0002" )
. WithPropertyRegex ( ".*" )
. WithMetadata ( "METADATA_0002" ),
}),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . createFormModelMaster (
new Gs2Formation . CreateFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withName ( "form-0001" )
. withDescription ( null )
. withMetadata ( null )
. withSlots ([
new Gs2Formation . model . SlotModel ()
. withName ( "slot-0001" )
. withPropertyRegex ( ".*" ),
new Gs2Formation . model . SlotModel ()
. withName ( "slot-0002" )
. withPropertyRegex ( ".*" )
. withMetadata ( "METADATA_0002" ),
])
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . create_form_model_master (
formation . CreateFormModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_name ( 'form-0001' )
. with_description ( None )
. with_metadata ( None )
. with_slots ([
formation . SlotModel ()
. with_name ( 'slot-0001' )
. with_property_regex ( '.*' ),
formation . SlotModel ()
. with_name ( 'slot-0002' )
. with_property_regex ( '.*' )
. with_metadata ( 'METADATA_0002' ),
])
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.create_form_model_master ({
namespaceName = "namespace-0001" ,
name = "form-0001" ,
description = nil ,
metadata = nil ,
slots = {
{
name = "slot-0001" ,
propertyRegex = ".*" ,
},
{
name = "slot-0002" ,
propertyRegex = ".*" ,
metadata = "METADATA_0002" ,
}
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.create_form_model_master_async ({
namespaceName = "namespace-0001" ,
name = "form-0001" ,
description = nil ,
metadata = nil ,
slots = {
{
name = "slot-0001" ,
propertyRegex = ".*" ,
},
{
name = "slot-0002" ,
propertyRegex = ".*" ,
metadata = "METADATA_0002" ,
}
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Get form model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name formModelName string ✓ ~ 128 chars Form model name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetFormModelMaster (
& formation . GetFormModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
FormModelName : pointy . String ( "form-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetFormModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getFormModelMaster (
( new GetFormModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withFormModelName ( "form-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetFormModelMasterRequest ;
import io.gs2.formation.result.GetFormModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetFormModelMasterResult result = client . getFormModelMaster (
new GetFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withFormModelName ( "form-0001" )
);
FormModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetFormModelMasterRequest ;
using Gs2.Gs2Formation.Result.GetFormModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetFormModelMasterResult > asyncResult = null ;
yield return client . GetFormModelMaster (
new Gs2 . Gs2Formation . Request . GetFormModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithFormModelName ( "form-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getFormModelMaster (
new Gs2Formation . GetFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withFormModelName ( "form-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_form_model_master (
formation . GetFormModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_form_model_name ( 'form-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_form_model_master ({
namespaceName = "namespace-0001" ,
formModelName = "form-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.get_form_model_master_async ({
namespaceName = "namespace-0001" ,
formModelName = "form-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Update form model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name formModelName string ✓ ~ 128 chars Form model name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata slots List<SlotModel> ✓ 1 ~ 10 items List of Slot Model
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . UpdateFormModelMaster (
& formation . UpdateFormModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
FormModelName : pointy . String ( "form-0001" ),
Description : pointy . String ( "description1" ),
Metadata : pointy . String ( "FORM_0001" ),
Slots : [] formation . SlotModel {
formation . SlotModel {
Name : pointy . String ( "slot-1101" ),
},
formation . SlotModel {
Name : pointy . String ( "slot-1102" ),
Metadata : pointy . String ( "METADATA_1102" ),
},
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\UpdateFormModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateFormModelMaster (
( new UpdateFormModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withFormModelName ( "form-0001" )
-> withDescription ( "description1" )
-> withMetadata ( "FORM_0001" )
-> withSlots ([
( new \Gs2\Formation\Model\SlotModel ())
-> withName ( "slot-1101" ),
( new \Gs2\Formation\Model\SlotModel ())
-> withName ( "slot-1102" )
-> withMetadata ( "METADATA_1102" ),
])
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.UpdateFormModelMasterRequest ;
import io.gs2.formation.result.UpdateFormModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
UpdateFormModelMasterResult result = client . updateFormModelMaster (
new UpdateFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withFormModelName ( "form-0001" )
. withDescription ( "description1" )
. withMetadata ( "FORM_0001" )
. withSlots ( Arrays . asList (
new io . gs2 . formation . model . SlotModel ()
. withName ( "slot-1101" ),
new io . gs2 . formation . model . SlotModel ()
. withName ( "slot-1102" )
. withMetadata ( "METADATA_1102" )
))
);
FormModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.UpdateFormModelMasterRequest ;
using Gs2.Gs2Formation.Result.UpdateFormModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . UpdateFormModelMasterResult > asyncResult = null ;
yield return client . UpdateFormModelMaster (
new Gs2 . Gs2Formation . Request . UpdateFormModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithFormModelName ( "form-0001" )
. WithDescription ( "description1" )
. WithMetadata ( "FORM_0001" )
. WithSlots ( new Gs2 . Gs2Formation . Model . SlotModel [] {
new Gs2 . Gs2Formation . Model . SlotModel ()
. WithName ( "slot-1101" ),
new Gs2 . Gs2Formation . Model . SlotModel ()
. WithName ( "slot-1102" )
. WithMetadata ( "METADATA_1102" ),
}),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . updateFormModelMaster (
new Gs2Formation . UpdateFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withFormModelName ( "form-0001" )
. withDescription ( "description1" )
. withMetadata ( "FORM_0001" )
. withSlots ([
new Gs2Formation . model . SlotModel ()
. withName ( "slot-1101" ),
new Gs2Formation . model . SlotModel ()
. withName ( "slot-1102" )
. withMetadata ( "METADATA_1102" ),
])
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . update_form_model_master (
formation . UpdateFormModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_form_model_name ( 'form-0001' )
. with_description ( 'description1' )
. with_metadata ( 'FORM_0001' )
. with_slots ([
formation . SlotModel ()
. with_name ( 'slot-1101' ),
formation . SlotModel ()
. with_name ( 'slot-1102' )
. with_metadata ( 'METADATA_1102' ),
])
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.update_form_model_master ({
namespaceName = "namespace-0001" ,
formModelName = "form-0001" ,
description = "description1" ,
metadata = "FORM_0001" ,
slots = {
{
name = "slot-1101" ,
},
{
name = "slot-1102" ,
metadata = "METADATA_1102" ,
}
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.update_form_model_master_async ({
namespaceName = "namespace-0001" ,
formModelName = "form-0001" ,
description = "description1" ,
metadata = "FORM_0001" ,
slots = {
{
name = "slot-1101" ,
},
{
name = "slot-1102" ,
metadata = "METADATA_1102" ,
}
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Delete form model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name formModelName string ✓ ~ 128 chars Form model name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeleteFormModelMaster (
& formation . DeleteFormModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
FormModelName : pointy . String ( "form-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeleteFormModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteFormModelMaster (
( new DeleteFormModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withFormModelName ( "form-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeleteFormModelMasterRequest ;
import io.gs2.formation.result.DeleteFormModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeleteFormModelMasterResult result = client . deleteFormModelMaster (
new DeleteFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withFormModelName ( "form-0001" )
);
FormModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeleteFormModelMasterRequest ;
using Gs2.Gs2Formation.Result.DeleteFormModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeleteFormModelMasterResult > asyncResult = null ;
yield return client . DeleteFormModelMaster (
new Gs2 . Gs2Formation . Request . DeleteFormModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithFormModelName ( "form-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deleteFormModelMaster (
new Gs2Formation . DeleteFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withFormModelName ( "form-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_form_model_master (
formation . DeleteFormModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_form_model_name ( 'form-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_form_model_master ({
namespaceName = "namespace-0001" ,
formModelName = "form-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.delete_form_model_master_async ({
namespaceName = "namespace-0001" ,
formModelName = "form-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; describeMoldModels Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribeMoldModels (
& formation . DescribeMoldModelsRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribeMoldModelsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeMoldModels (
( new DescribeMoldModelsRequest ())
-> withNamespaceName ( "namespace-0001" )
);
$items = $result -> getItems ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribeMoldModelsRequest ;
import io.gs2.formation.result.DescribeMoldModelsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribeMoldModelsResult result = client . describeMoldModels (
new DescribeMoldModelsRequest ()
. withNamespaceName ( "namespace-0001" )
);
List < MoldModel > items = result . getItems ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribeMoldModelsRequest ;
using Gs2.Gs2Formation.Result.DescribeMoldModelsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribeMoldModelsResult > asyncResult = null ;
yield return client . DescribeMoldModels (
new Gs2 . Gs2Formation . Request . DescribeMoldModelsRequest ()
. WithNamespaceName ( "namespace-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describeMoldModels (
new Gs2Formation . DescribeMoldModelsRequest ()
. withNamespaceName ( "namespace-0001" )
);
const items = result . getItems ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_mold_models (
formation . DescribeMoldModelsRequest ()
. with_namespace_name ( 'namespace-0001' )
)
items = result . items
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_mold_models ({
namespaceName = "namespace-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ; client = gs2 ( 'formation' )
api_result_handler = client.describe_mold_models_async ({
namespaceName = "namespace-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ; getMoldModel Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name moldModelName string ✓ ~ 128 chars Form storage area model name
Result Type Description item MoldModel Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetMoldModel (
& formation . GetMoldModelRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetMoldModelRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getMoldModel (
( new GetMoldModelRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withMoldModelName ( "mold-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetMoldModelRequest ;
import io.gs2.formation.result.GetMoldModelResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetMoldModelResult result = client . getMoldModel (
new GetMoldModelRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
);
MoldModel item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetMoldModelRequest ;
using Gs2.Gs2Formation.Result.GetMoldModelResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetMoldModelResult > asyncResult = null ;
yield return client . GetMoldModel (
new Gs2 . Gs2Formation . Request . GetMoldModelRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithMoldModelName ( "mold-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getMoldModel (
new Gs2Formation . GetMoldModelRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_mold_model (
formation . GetMoldModelRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_mold_model_name ( 'mold-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_mold_model ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.get_mold_model_async ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; describeMoldModelMasters Get list of form storage area masters
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired
Result Type Description items List<MoldModelMaster> List of Form storage area master nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribeMoldModelMasters (
& formation . DescribeMoldModelMastersRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribeMoldModelMastersRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeMoldModelMasters (
( new DescribeMoldModelMastersRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribeMoldModelMastersRequest ;
import io.gs2.formation.result.DescribeMoldModelMastersResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribeMoldModelMastersResult result = client . describeMoldModelMasters (
new DescribeMoldModelMastersRequest ()
. withNamespaceName ( "namespace-0001" )
. withPageToken ( null )
. withLimit ( null )
);
List < MoldModelMaster > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribeMoldModelMastersRequest ;
using Gs2.Gs2Formation.Result.DescribeMoldModelMastersResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribeMoldModelMastersResult > asyncResult = null ;
yield return client . DescribeMoldModelMasters (
new Gs2 . Gs2Formation . Request . DescribeMoldModelMastersRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describeMoldModelMasters (
new Gs2Formation . DescribeMoldModelMastersRequest ()
. withNamespaceName ( "namespace-0001" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_mold_model_masters (
formation . DescribeMoldModelMastersRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_mold_model_masters ({
namespaceName = "namespace-0001" ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_mold_model_masters_async ({
namespaceName = "namespace-0001" ,
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; createMoldModelMaster Create new form storage area master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name name string ✓ ~ 128 chars Form storage area model name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata formModelName string ✓ ~ 128 chars Form model name initialMaxCapacity int ✓ 1 ~ 2147483646 Initial capacity to store forms maxCapacity int ✓ 1 ~ 2147483646 Maximum capacity to store forms
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . CreateMoldModelMaster (
& formation . CreateMoldModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
Name : pointy . String ( "mold-0001" ),
Description : nil ,
Metadata : nil ,
FormModelName : pointy . String ( "formModel-0001" ),
InitialMaxCapacity : pointy . Int32 ( 5 ),
MaxCapacity : pointy . Int32 ( 10 ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\CreateMoldModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createMoldModelMaster (
( new CreateMoldModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withName ( "mold-0001" )
-> withDescription ( null )
-> withMetadata ( null )
-> withFormModelName ( "formModel-0001" )
-> withInitialMaxCapacity ( 5 )
-> withMaxCapacity ( 10 )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.CreateMoldModelMasterRequest ;
import io.gs2.formation.result.CreateMoldModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
CreateMoldModelMasterResult result = client . createMoldModelMaster (
new CreateMoldModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withName ( "mold-0001" )
. withDescription ( null )
. withMetadata ( null )
. withFormModelName ( "formModel-0001" )
. withInitialMaxCapacity ( 5 )
. withMaxCapacity ( 10 )
);
MoldModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.CreateMoldModelMasterRequest ;
using Gs2.Gs2Formation.Result.CreateMoldModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . CreateMoldModelMasterResult > asyncResult = null ;
yield return client . CreateMoldModelMaster (
new Gs2 . Gs2Formation . Request . CreateMoldModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithName ( "mold-0001" )
. WithDescription ( null )
. WithMetadata ( null )
. WithFormModelName ( "formModel-0001" )
. WithInitialMaxCapacity ( 5 )
. WithMaxCapacity ( 10 ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . createMoldModelMaster (
new Gs2Formation . CreateMoldModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withName ( "mold-0001" )
. withDescription ( null )
. withMetadata ( null )
. withFormModelName ( "formModel-0001" )
. withInitialMaxCapacity ( 5 )
. withMaxCapacity ( 10 )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . create_mold_model_master (
formation . CreateMoldModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_name ( 'mold-0001' )
. with_description ( None )
. with_metadata ( None )
. with_form_model_name ( 'formModel-0001' )
. with_initial_max_capacity ( 5 )
. with_max_capacity ( 10 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.create_mold_model_master ({
namespaceName = "namespace-0001" ,
name = "mold-0001" ,
description = nil ,
metadata = nil ,
formModelName = "formModel-0001" ,
initialMaxCapacity = 5 ,
maxCapacity = 10 ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.create_mold_model_master_async ({
namespaceName = "namespace-0001" ,
name = "mold-0001" ,
description = nil ,
metadata = nil ,
formModelName = "formModel-0001" ,
initialMaxCapacity = 5 ,
maxCapacity = 10 ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; getMoldModelMaster Get form storage area master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name moldModelName string ✓ ~ 128 chars Form storage area model name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetMoldModelMaster (
& formation . GetMoldModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetMoldModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getMoldModelMaster (
( new GetMoldModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withMoldModelName ( "mold-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetMoldModelMasterRequest ;
import io.gs2.formation.result.GetMoldModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetMoldModelMasterResult result = client . getMoldModelMaster (
new GetMoldModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
);
MoldModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetMoldModelMasterRequest ;
using Gs2.Gs2Formation.Result.GetMoldModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetMoldModelMasterResult > asyncResult = null ;
yield return client . GetMoldModelMaster (
new Gs2 . Gs2Formation . Request . GetMoldModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithMoldModelName ( "mold-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getMoldModelMaster (
new Gs2Formation . GetMoldModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_mold_model_master (
formation . GetMoldModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_mold_model_name ( 'mold-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_mold_model_master ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.get_mold_model_master_async ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; updateMoldModelMaster Update form storage area master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name moldModelName string ✓ ~ 128 chars Form storage area model name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata formModelName string ✓ ~ 128 chars Form model name initialMaxCapacity int ✓ 1 ~ 2147483646 Initial capacity to store forms maxCapacity int ✓ 1 ~ 2147483646 Maximum capacity to store forms
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . UpdateMoldModelMaster (
& formation . UpdateMoldModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Description : nil ,
Metadata : nil ,
FormModelName : pointy . String ( "formModel-0001" ),
InitialMaxCapacity : pointy . Int32 ( 5 ),
MaxCapacity : pointy . Int32 ( 15 ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\UpdateMoldModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateMoldModelMaster (
( new UpdateMoldModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withMoldModelName ( "mold-0001" )
-> withDescription ( null )
-> withMetadata ( null )
-> withFormModelName ( "formModel-0001" )
-> withInitialMaxCapacity ( 5 )
-> withMaxCapacity ( 15 )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.UpdateMoldModelMasterRequest ;
import io.gs2.formation.result.UpdateMoldModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
UpdateMoldModelMasterResult result = client . updateMoldModelMaster (
new UpdateMoldModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
. withDescription ( null )
. withMetadata ( null )
. withFormModelName ( "formModel-0001" )
. withInitialMaxCapacity ( 5 )
. withMaxCapacity ( 15 )
);
MoldModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.UpdateMoldModelMasterRequest ;
using Gs2.Gs2Formation.Result.UpdateMoldModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . UpdateMoldModelMasterResult > asyncResult = null ;
yield return client . UpdateMoldModelMaster (
new Gs2 . Gs2Formation . Request . UpdateMoldModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithMoldModelName ( "mold-0001" )
. WithDescription ( null )
. WithMetadata ( null )
. WithFormModelName ( "formModel-0001" )
. WithInitialMaxCapacity ( 5 )
. WithMaxCapacity ( 15 ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . updateMoldModelMaster (
new Gs2Formation . UpdateMoldModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
. withDescription ( null )
. withMetadata ( null )
. withFormModelName ( "formModel-0001" )
. withInitialMaxCapacity ( 5 )
. withMaxCapacity ( 15 )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . update_mold_model_master (
formation . UpdateMoldModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_description ( None )
. with_metadata ( None )
. with_form_model_name ( 'formModel-0001' )
. with_initial_max_capacity ( 5 )
. with_max_capacity ( 15 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.update_mold_model_master ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
description = nil ,
metadata = nil ,
formModelName = "formModel-0001" ,
initialMaxCapacity = 5 ,
maxCapacity = 15 ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.update_mold_model_master_async ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
description = nil ,
metadata = nil ,
formModelName = "formModel-0001" ,
initialMaxCapacity = 5 ,
maxCapacity = 15 ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; deleteMoldModelMaster Delete form storage area master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name moldModelName string ✓ ~ 128 chars Form storage area model name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeleteMoldModelMaster (
& formation . DeleteMoldModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeleteMoldModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteMoldModelMaster (
( new DeleteMoldModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withMoldModelName ( "mold-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeleteMoldModelMasterRequest ;
import io.gs2.formation.result.DeleteMoldModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeleteMoldModelMasterResult result = client . deleteMoldModelMaster (
new DeleteMoldModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
);
MoldModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeleteMoldModelMasterRequest ;
using Gs2.Gs2Formation.Result.DeleteMoldModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeleteMoldModelMasterResult > asyncResult = null ;
yield return client . DeleteMoldModelMaster (
new Gs2 . Gs2Formation . Request . DeleteMoldModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithMoldModelName ( "mold-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deleteMoldModelMaster (
new Gs2Formation . DeleteMoldModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_mold_model_master (
formation . DeleteMoldModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_mold_model_name ( 'mold-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_mold_model_master ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.delete_mold_model_master_async ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Get a list of property form
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribePropertyFormModels (
& formation . DescribePropertyFormModelsRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribePropertyFormModelsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describePropertyFormModels (
( new DescribePropertyFormModelsRequest ())
-> withNamespaceName ( "namespace-0001" )
);
$items = $result -> getItems ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribePropertyFormModelsRequest ;
import io.gs2.formation.result.DescribePropertyFormModelsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribePropertyFormModelsResult result = client . describePropertyFormModels (
new DescribePropertyFormModelsRequest ()
. withNamespaceName ( "namespace-0001" )
);
List < PropertyFormModel > items = result . getItems ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribePropertyFormModelsRequest ;
using Gs2.Gs2Formation.Result.DescribePropertyFormModelsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribePropertyFormModelsResult > asyncResult = null ;
yield return client . DescribePropertyFormModels (
new Gs2 . Gs2Formation . Request . DescribePropertyFormModelsRequest ()
. WithNamespaceName ( "namespace-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describePropertyFormModels (
new Gs2Formation . DescribePropertyFormModelsRequest ()
. withNamespaceName ( "namespace-0001" )
);
const items = result . getItems ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_property_form_models (
formation . DescribePropertyFormModelsRequest ()
. with_namespace_name ( 'namespace-0001' )
)
items = result . items
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_property_form_models ({
namespaceName = "namespace-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ; client = gs2 ( 'formation' )
api_result_handler = client.describe_property_form_models_async ({
namespaceName = "namespace-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ; Get Property Form
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name propertyFormModelName string ✓ ~ 128 chars Property form model name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetPropertyFormModel (
& formation . GetPropertyFormModelRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetPropertyFormModelRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getPropertyFormModel (
( new GetPropertyFormModelRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withPropertyFormModelName ( "form-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetPropertyFormModelRequest ;
import io.gs2.formation.result.GetPropertyFormModelResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetPropertyFormModelResult result = client . getPropertyFormModel (
new GetPropertyFormModelRequest ()
. withNamespaceName ( "namespace-0001" )
. withPropertyFormModelName ( "form-0001" )
);
PropertyFormModel item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetPropertyFormModelRequest ;
using Gs2.Gs2Formation.Result.GetPropertyFormModelResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetPropertyFormModelResult > asyncResult = null ;
yield return client . GetPropertyFormModel (
new Gs2 . Gs2Formation . Request . GetPropertyFormModelRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithPropertyFormModelName ( "form-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getPropertyFormModel (
new Gs2Formation . GetPropertyFormModelRequest ()
. withNamespaceName ( "namespace-0001" )
. withPropertyFormModelName ( "form-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_property_form_model (
formation . GetPropertyFormModelRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_property_form_model_name ( 'form-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_property_form_model ({
namespaceName = "namespace-0001" ,
propertyFormModelName = "form-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.get_property_form_model_async ({
namespaceName = "namespace-0001" ,
propertyFormModelName = "form-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribePropertyFormModelMasters (
& formation . DescribePropertyFormModelMastersRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribePropertyFormModelMastersRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describePropertyFormModelMasters (
( new DescribePropertyFormModelMastersRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribePropertyFormModelMastersRequest ;
import io.gs2.formation.result.DescribePropertyFormModelMastersResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribePropertyFormModelMastersResult result = client . describePropertyFormModelMasters (
new DescribePropertyFormModelMastersRequest ()
. withNamespaceName ( "namespace-0001" )
. withPageToken ( null )
. withLimit ( null )
);
List < PropertyFormModelMaster > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribePropertyFormModelMastersRequest ;
using Gs2.Gs2Formation.Result.DescribePropertyFormModelMastersResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribePropertyFormModelMastersResult > asyncResult = null ;
yield return client . DescribePropertyFormModelMasters (
new Gs2 . Gs2Formation . Request . DescribePropertyFormModelMastersRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describePropertyFormModelMasters (
new Gs2Formation . DescribePropertyFormModelMastersRequest ()
. withNamespaceName ( "namespace-0001" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_property_form_model_masters (
formation . DescribePropertyFormModelMastersRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_property_form_model_masters ({
namespaceName = "namespace-0001" ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_property_form_model_masters_async ({
namespaceName = "namespace-0001" ,
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; Create new form model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name name string ✓ ~ 128 chars Property form model name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata slots List<SlotModel> ✓ 1 ~ 10 items List of Slot Model
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . CreatePropertyFormModelMaster (
& formation . CreatePropertyFormModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
Name : pointy . String ( "form-0001" ),
Description : nil ,
Metadata : nil ,
Slots : [] formation . SlotModel {
formation . SlotModel {
Name : pointy . String ( "slot-0001" ),
PropertyRegex : pointy . String ( ".*" ),
},
formation . SlotModel {
Name : pointy . String ( "slot-0002" ),
PropertyRegex : pointy . String ( ".*" ),
Metadata : pointy . String ( "METADATA_0002" ),
},
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\CreatePropertyFormModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createPropertyFormModelMaster (
( new CreatePropertyFormModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withName ( "form-0001" )
-> withDescription ( null )
-> withMetadata ( null )
-> withSlots ([
( new \Gs2\Formation\Model\SlotModel ())
-> withName ( "slot-0001" )
-> withPropertyRegex ( ".*" ),
( new \Gs2\Formation\Model\SlotModel ())
-> withName ( "slot-0002" )
-> withPropertyRegex ( ".*" )
-> withMetadata ( "METADATA_0002" ),
])
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.CreatePropertyFormModelMasterRequest ;
import io.gs2.formation.result.CreatePropertyFormModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
CreatePropertyFormModelMasterResult result = client . createPropertyFormModelMaster (
new CreatePropertyFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withName ( "form-0001" )
. withDescription ( null )
. withMetadata ( null )
. withSlots ( Arrays . asList (
new io . gs2 . formation . model . SlotModel ()
. withName ( "slot-0001" )
. withPropertyRegex ( ".*" ),
new io . gs2 . formation . model . SlotModel ()
. withName ( "slot-0002" )
. withPropertyRegex ( ".*" )
. withMetadata ( "METADATA_0002" )
))
);
PropertyFormModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.CreatePropertyFormModelMasterRequest ;
using Gs2.Gs2Formation.Result.CreatePropertyFormModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . CreatePropertyFormModelMasterResult > asyncResult = null ;
yield return client . CreatePropertyFormModelMaster (
new Gs2 . Gs2Formation . Request . CreatePropertyFormModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithName ( "form-0001" )
. WithDescription ( null )
. WithMetadata ( null )
. WithSlots ( new Gs2 . Gs2Formation . Model . SlotModel [] {
new Gs2 . Gs2Formation . Model . SlotModel ()
. WithName ( "slot-0001" )
. WithPropertyRegex ( ".*" ),
new Gs2 . Gs2Formation . Model . SlotModel ()
. WithName ( "slot-0002" )
. WithPropertyRegex ( ".*" )
. WithMetadata ( "METADATA_0002" ),
}),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . createPropertyFormModelMaster (
new Gs2Formation . CreatePropertyFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withName ( "form-0001" )
. withDescription ( null )
. withMetadata ( null )
. withSlots ([
new Gs2Formation . model . SlotModel ()
. withName ( "slot-0001" )
. withPropertyRegex ( ".*" ),
new Gs2Formation . model . SlotModel ()
. withName ( "slot-0002" )
. withPropertyRegex ( ".*" )
. withMetadata ( "METADATA_0002" ),
])
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . create_property_form_model_master (
formation . CreatePropertyFormModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_name ( 'form-0001' )
. with_description ( None )
. with_metadata ( None )
. with_slots ([
formation . SlotModel ()
. with_name ( 'slot-0001' )
. with_property_regex ( '.*' ),
formation . SlotModel ()
. with_name ( 'slot-0002' )
. with_property_regex ( '.*' )
. with_metadata ( 'METADATA_0002' ),
])
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.create_property_form_model_master ({
namespaceName = "namespace-0001" ,
name = "form-0001" ,
description = nil ,
metadata = nil ,
slots = {
{
name = "slot-0001" ,
propertyRegex = ".*" ,
},
{
name = "slot-0002" ,
propertyRegex = ".*" ,
metadata = "METADATA_0002" ,
}
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.create_property_form_model_master_async ({
namespaceName = "namespace-0001" ,
name = "form-0001" ,
description = nil ,
metadata = nil ,
slots = {
{
name = "slot-0001" ,
propertyRegex = ".*" ,
},
{
name = "slot-0002" ,
propertyRegex = ".*" ,
metadata = "METADATA_0002" ,
}
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Get form model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name propertyFormModelName string ✓ ~ 128 chars Property form model name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetPropertyFormModelMaster (
& formation . GetPropertyFormModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetPropertyFormModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getPropertyFormModelMaster (
( new GetPropertyFormModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withPropertyFormModelName ( "form-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetPropertyFormModelMasterRequest ;
import io.gs2.formation.result.GetPropertyFormModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetPropertyFormModelMasterResult result = client . getPropertyFormModelMaster (
new GetPropertyFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withPropertyFormModelName ( "form-0001" )
);
PropertyFormModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetPropertyFormModelMasterRequest ;
using Gs2.Gs2Formation.Result.GetPropertyFormModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetPropertyFormModelMasterResult > asyncResult = null ;
yield return client . GetPropertyFormModelMaster (
new Gs2 . Gs2Formation . Request . GetPropertyFormModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithPropertyFormModelName ( "form-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getPropertyFormModelMaster (
new Gs2Formation . GetPropertyFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withPropertyFormModelName ( "form-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_property_form_model_master (
formation . GetPropertyFormModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_property_form_model_name ( 'form-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_property_form_model_master ({
namespaceName = "namespace-0001" ,
propertyFormModelName = "form-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.get_property_form_model_master_async ({
namespaceName = "namespace-0001" ,
propertyFormModelName = "form-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Update form model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name propertyFormModelName string ✓ ~ 128 chars Property form model name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata slots List<SlotModel> ✓ 1 ~ 10 items List of Slot Model
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . UpdatePropertyFormModelMaster (
& formation . UpdatePropertyFormModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
Description : pointy . String ( "description1" ),
Metadata : pointy . String ( "FORM_0001" ),
Slots : [] formation . SlotModel {
formation . SlotModel {
Name : pointy . String ( "slot-1101" ),
},
formation . SlotModel {
Name : pointy . String ( "slot-1102" ),
Metadata : pointy . String ( "METADATA_1102" ),
},
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\UpdatePropertyFormModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updatePropertyFormModelMaster (
( new UpdatePropertyFormModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withDescription ( "description1" )
-> withMetadata ( "FORM_0001" )
-> withSlots ([
( new \Gs2\Formation\Model\SlotModel ())
-> withName ( "slot-1101" ),
( new \Gs2\Formation\Model\SlotModel ())
-> withName ( "slot-1102" )
-> withMetadata ( "METADATA_1102" ),
])
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.UpdatePropertyFormModelMasterRequest ;
import io.gs2.formation.result.UpdatePropertyFormModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
UpdatePropertyFormModelMasterResult result = client . updatePropertyFormModelMaster (
new UpdatePropertyFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withPropertyFormModelName ( "form-0001" )
. withDescription ( "description1" )
. withMetadata ( "FORM_0001" )
. withSlots ( Arrays . asList (
new io . gs2 . formation . model . SlotModel ()
. withName ( "slot-1101" ),
new io . gs2 . formation . model . SlotModel ()
. withName ( "slot-1102" )
. withMetadata ( "METADATA_1102" )
))
);
PropertyFormModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.UpdatePropertyFormModelMasterRequest ;
using Gs2.Gs2Formation.Result.UpdatePropertyFormModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . UpdatePropertyFormModelMasterResult > asyncResult = null ;
yield return client . UpdatePropertyFormModelMaster (
new Gs2 . Gs2Formation . Request . UpdatePropertyFormModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithDescription ( "description1" )
. WithMetadata ( "FORM_0001" )
. WithSlots ( new Gs2 . Gs2Formation . Model . SlotModel [] {
new Gs2 . Gs2Formation . Model . SlotModel ()
. WithName ( "slot-1101" ),
new Gs2 . Gs2Formation . Model . SlotModel ()
. WithName ( "slot-1102" )
. WithMetadata ( "METADATA_1102" ),
}),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . updatePropertyFormModelMaster (
new Gs2Formation . UpdatePropertyFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withPropertyFormModelName ( "form-0001" )
. withDescription ( "description1" )
. withMetadata ( "FORM_0001" )
. withSlots ([
new Gs2Formation . model . SlotModel ()
. withName ( "slot-1101" ),
new Gs2Formation . model . SlotModel ()
. withName ( "slot-1102" )
. withMetadata ( "METADATA_1102" ),
])
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . update_property_form_model_master (
formation . UpdatePropertyFormModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_description ( 'description1' )
. with_metadata ( 'FORM_0001' )
. with_slots ([
formation . SlotModel ()
. with_name ( 'slot-1101' ),
formation . SlotModel ()
. with_name ( 'slot-1102' )
. with_metadata ( 'METADATA_1102' ),
])
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.update_property_form_model_master ({
namespaceName = "namespace-0001" ,
propertyFormModelName = "form-0001" ,
description = "description1" ,
metadata = "FORM_0001" ,
slots = {
{
name = "slot-1101" ,
},
{
name = "slot-1102" ,
metadata = "METADATA_1102" ,
}
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.update_property_form_model_master_async ({
namespaceName = "namespace-0001" ,
propertyFormModelName = "form-0001" ,
description = "description1" ,
metadata = "FORM_0001" ,
slots = {
{
name = "slot-1101" ,
},
{
name = "slot-1102" ,
metadata = "METADATA_1102" ,
}
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Delete form model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name propertyFormModelName string ✓ ~ 128 chars Property form model name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeletePropertyFormModelMaster (
& formation . DeletePropertyFormModelMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeletePropertyFormModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deletePropertyFormModelMaster (
( new DeletePropertyFormModelMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withPropertyFormModelName ( "form-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeletePropertyFormModelMasterRequest ;
import io.gs2.formation.result.DeletePropertyFormModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeletePropertyFormModelMasterResult result = client . deletePropertyFormModelMaster (
new DeletePropertyFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withPropertyFormModelName ( "form-0001" )
);
PropertyFormModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeletePropertyFormModelMasterRequest ;
using Gs2.Gs2Formation.Result.DeletePropertyFormModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeletePropertyFormModelMasterResult > asyncResult = null ;
yield return client . DeletePropertyFormModelMaster (
new Gs2 . Gs2Formation . Request . DeletePropertyFormModelMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithPropertyFormModelName ( "form-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deletePropertyFormModelMaster (
new Gs2Formation . DeletePropertyFormModelMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withPropertyFormModelName ( "form-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_property_form_model_master (
formation . DeletePropertyFormModelMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_property_form_model_name ( 'form-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_property_form_model_master ({
namespaceName = "namespace-0001" ,
propertyFormModelName = "form-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.delete_property_form_model_master_async ({
namespaceName = "namespace-0001" ,
propertyFormModelName = "form-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; exportMaster Export master data for currently available form settings
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . ExportMaster (
& formation . ExportMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\ExportMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> exportMaster (
( new ExportMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.ExportMasterRequest ;
import io.gs2.formation.result.ExportMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
ExportMasterResult result = client . exportMaster (
new ExportMasterRequest ()
. withNamespaceName ( "namespace-0001" )
);
CurrentFormMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.ExportMasterRequest ;
using Gs2.Gs2Formation.Result.ExportMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . ExportMasterResult > asyncResult = null ;
yield return client . ExportMaster (
new Gs2 . Gs2Formation . Request . ExportMasterRequest ()
. WithNamespaceName ( "namespace-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . exportMaster (
new Gs2Formation . ExportMasterRequest ()
. withNamespaceName ( "namespace-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . export_master (
formation . ExportMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.export_master ({
namespaceName = "namespace-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.export_master_async ({
namespaceName = "namespace-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Get the currently available form settings
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetCurrentFormMaster (
& formation . GetCurrentFormMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetCurrentFormMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getCurrentFormMaster (
( new GetCurrentFormMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetCurrentFormMasterRequest ;
import io.gs2.formation.result.GetCurrentFormMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetCurrentFormMasterResult result = client . getCurrentFormMaster (
new GetCurrentFormMasterRequest ()
. withNamespaceName ( "namespace-0001" )
);
CurrentFormMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetCurrentFormMasterRequest ;
using Gs2.Gs2Formation.Result.GetCurrentFormMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetCurrentFormMasterResult > asyncResult = null ;
yield return client . GetCurrentFormMaster (
new Gs2 . Gs2Formation . Request . GetCurrentFormMasterRequest ()
. WithNamespaceName ( "namespace-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getCurrentFormMaster (
new Gs2Formation . GetCurrentFormMasterRequest ()
. withNamespaceName ( "namespace-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_current_form_master (
formation . GetCurrentFormMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_current_form_master ({
namespaceName = "namespace-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.get_current_form_master_async ({
namespaceName = "namespace-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Update the currently available model settings
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name
Result Type Description uploadToken string Token used to reflect results after upload uploadUrl string URL used to upload
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . PreUpdateCurrentFormMaster (
& formation . PreUpdateCurrentFormMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
uploadToken := result . UploadToken
uploadUrl := result . UploadUrl use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\PreUpdateCurrentFormMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> preUpdateCurrentFormMaster (
( new PreUpdateCurrentFormMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
);
$uploadToken = $result -> getUploadToken ();
$uploadUrl = $result -> getUploadUrl ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.PreUpdateCurrentFormMasterRequest ;
import io.gs2.formation.result.PreUpdateCurrentFormMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
PreUpdateCurrentFormMasterResult result = client . preUpdateCurrentFormMaster (
new PreUpdateCurrentFormMasterRequest ()
. withNamespaceName ( "namespace-0001" )
);
String uploadToken = result . getUploadToken ();
String uploadUrl = result . getUploadUrl ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.PreUpdateCurrentFormMasterRequest ;
using Gs2.Gs2Formation.Result.PreUpdateCurrentFormMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . PreUpdateCurrentFormMasterResult > asyncResult = null ;
yield return client . PreUpdateCurrentFormMaster (
new Gs2 . Gs2Formation . Request . PreUpdateCurrentFormMasterRequest ()
. WithNamespaceName ( "namespace-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var uploadToken = result . UploadToken ;
var uploadUrl = result . UploadUrl ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . preUpdateCurrentFormMaster (
new Gs2Formation . PreUpdateCurrentFormMasterRequest ()
. withNamespaceName ( "namespace-0001" )
);
const uploadToken = result . getUploadToken ();
const uploadUrl = result . getUploadUrl ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . pre_update_current_form_master (
formation . PreUpdateCurrentFormMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
)
upload_token = result . upload_token
upload_url = result . upload_url
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.pre_update_current_form_master ({
namespaceName = "namespace-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
uploadToken = result.uploadToken ;
uploadUrl = result.uploadUrl ; client = gs2 ( 'formation' )
api_result_handler = client.pre_update_current_form_master_async ({
namespaceName = "namespace-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
uploadToken = result.uploadToken ;
uploadUrl = result.uploadUrl ; Updates the currently available form settings
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name mode enum { ✓ “direct” ~ 128 chars Update mode settings string {mode} == “direct” ✓ ~ 5242880 chars Master data uploadToken string {mode} == “preUpload” ✓ ~ 1024 chars Token used to reflect results after upload
Enumeration type definition to specify as mode Enumerator String Definition Description direct Directly update the settings preUpload Upload the settings and then update
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . UpdateCurrentFormMaster (
& formation . UpdateCurrentFormMasterRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
Mode : nil ,
Settings : pointy . String ( "{\n \"version\": \"2019-09-09\",\n \"moldModels\": [\n {\n \"name\": \"party\",\n \"metadata\": \"PARTY\",\n \"formModel\": {\n \"name\": \"party\",\n \"metadata\": \"PARTY\",\n \"slots\": [\n {\n \"name\": \"tank\",\n \"metadata\": \"TANK\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"healer\",\n \"metadata\": \"HEALER\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"dps_1\",\n \"metadata\": \"DPS\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"dps_2\",\n \"metadata\": \"DPS\",\n \"propertyRegex\": \"grn:.*\"\n }\n ]\n },\n \"initialMaxCapacity\": 10,\n \"maxCapacity\": 20\n },\n {\n \"name\": \"equipment\",\n \"metadata\": \"EQUIPMENT\",\n \"formModel\": {\n \"name\": \"equipment\",\n \"metadata\": \"EQUIPMENT\",\n \"slots\": [\n {\n \"name\": \"head\",\n \"metadata\": \"HEAD\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"body\",\n \"metadata\": \"BODY\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"leg\",\n \"metadata\": \"LEG\",\n \"propertyRegex\": \"grn:.*\"\n }\n ]\n },\n \"initialMaxCapacity\": 20,\n \"maxCapacity\": 30\n }\n ]\n}" ),
UploadToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\UpdateCurrentFormMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateCurrentFormMaster (
( new UpdateCurrentFormMasterRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withMode ( null )
-> withSettings ( "{ \n \" version \" : \" 2019-09-09 \" , \n \" moldModels \" : [ \n { \n \" name \" : \" party \" , \n \" metadata \" : \" PARTY \" , \n \" formModel \" : { \n \" name \" : \" party \" , \n \" metadata \" : \" PARTY \" , \n \" slots \" : [ \n { \n \" name \" : \" tank \" , \n \" metadata \" : \" TANK \" , \n \" propertyRegex \" : \" grn:.* \"\n }, \n { \n \" name \" : \" healer \" , \n \" metadata \" : \" HEALER \" , \n \" propertyRegex \" : \" grn:.* \"\n }, \n { \n \" name \" : \" dps_1 \" , \n \" metadata \" : \" DPS \" , \n \" propertyRegex \" : \" grn:.* \"\n }, \n { \n \" name \" : \" dps_2 \" , \n \" metadata \" : \" DPS \" , \n \" propertyRegex \" : \" grn:.* \"\n } \n ] \n }, \n \" initialMaxCapacity \" : 10, \n \" maxCapacity \" : 20 \n }, \n { \n \" name \" : \" equipment \" , \n \" metadata \" : \" EQUIPMENT \" , \n \" formModel \" : { \n \" name \" : \" equipment \" , \n \" metadata \" : \" EQUIPMENT \" , \n \" slots \" : [ \n { \n \" name \" : \" head \" , \n \" metadata \" : \" HEAD \" , \n \" propertyRegex \" : \" grn:.* \"\n }, \n { \n \" name \" : \" body \" , \n \" metadata \" : \" BODY \" , \n \" propertyRegex \" : \" grn:.* \"\n }, \n { \n \" name \" : \" leg \" , \n \" metadata \" : \" LEG \" , \n \" propertyRegex \" : \" grn:.* \"\n } \n ] \n }, \n \" initialMaxCapacity \" : 20, \n \" maxCapacity \" : 30 \n } \n ] \n }" )
-> withUploadToken ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.UpdateCurrentFormMasterRequest ;
import io.gs2.formation.result.UpdateCurrentFormMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
UpdateCurrentFormMasterResult result = client . updateCurrentFormMaster (
new UpdateCurrentFormMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withMode ( null )
. withSettings ( "{\n \"version\": \"2019-09-09\",\n \"moldModels\": [\n {\n \"name\": \"party\",\n \"metadata\": \"PARTY\",\n \"formModel\": {\n \"name\": \"party\",\n \"metadata\": \"PARTY\",\n \"slots\": [\n {\n \"name\": \"tank\",\n \"metadata\": \"TANK\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"healer\",\n \"metadata\": \"HEALER\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"dps_1\",\n \"metadata\": \"DPS\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"dps_2\",\n \"metadata\": \"DPS\",\n \"propertyRegex\": \"grn:.*\"\n }\n ]\n },\n \"initialMaxCapacity\": 10,\n \"maxCapacity\": 20\n },\n {\n \"name\": \"equipment\",\n \"metadata\": \"EQUIPMENT\",\n \"formModel\": {\n \"name\": \"equipment\",\n \"metadata\": \"EQUIPMENT\",\n \"slots\": [\n {\n \"name\": \"head\",\n \"metadata\": \"HEAD\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"body\",\n \"metadata\": \"BODY\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"leg\",\n \"metadata\": \"LEG\",\n \"propertyRegex\": \"grn:.*\"\n }\n ]\n },\n \"initialMaxCapacity\": 20,\n \"maxCapacity\": 30\n }\n ]\n}" )
. withUploadToken ( null )
);
CurrentFormMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.UpdateCurrentFormMasterRequest ;
using Gs2.Gs2Formation.Result.UpdateCurrentFormMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . UpdateCurrentFormMasterResult > asyncResult = null ;
yield return client . UpdateCurrentFormMaster (
new Gs2 . Gs2Formation . Request . UpdateCurrentFormMasterRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithMode ( null )
. WithSettings ( "{\n \"version\": \"2019-09-09\",\n \"moldModels\": [\n {\n \"name\": \"party\",\n \"metadata\": \"PARTY\",\n \"formModel\": {\n \"name\": \"party\",\n \"metadata\": \"PARTY\",\n \"slots\": [\n {\n \"name\": \"tank\",\n \"metadata\": \"TANK\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"healer\",\n \"metadata\": \"HEALER\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"dps_1\",\n \"metadata\": \"DPS\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"dps_2\",\n \"metadata\": \"DPS\",\n \"propertyRegex\": \"grn:.*\"\n }\n ]\n },\n \"initialMaxCapacity\": 10,\n \"maxCapacity\": 20\n },\n {\n \"name\": \"equipment\",\n \"metadata\": \"EQUIPMENT\",\n \"formModel\": {\n \"name\": \"equipment\",\n \"metadata\": \"EQUIPMENT\",\n \"slots\": [\n {\n \"name\": \"head\",\n \"metadata\": \"HEAD\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"body\",\n \"metadata\": \"BODY\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"leg\",\n \"metadata\": \"LEG\",\n \"propertyRegex\": \"grn:.*\"\n }\n ]\n },\n \"initialMaxCapacity\": 20,\n \"maxCapacity\": 30\n }\n ]\n}" )
. WithUploadToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . updateCurrentFormMaster (
new Gs2Formation . UpdateCurrentFormMasterRequest ()
. withNamespaceName ( "namespace-0001" )
. withMode ( null )
. withSettings ( "{\n \"version\": \"2019-09-09\",\n \"moldModels\": [\n {\n \"name\": \"party\",\n \"metadata\": \"PARTY\",\n \"formModel\": {\n \"name\": \"party\",\n \"metadata\": \"PARTY\",\n \"slots\": [\n {\n \"name\": \"tank\",\n \"metadata\": \"TANK\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"healer\",\n \"metadata\": \"HEALER\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"dps_1\",\n \"metadata\": \"DPS\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"dps_2\",\n \"metadata\": \"DPS\",\n \"propertyRegex\": \"grn:.*\"\n }\n ]\n },\n \"initialMaxCapacity\": 10,\n \"maxCapacity\": 20\n },\n {\n \"name\": \"equipment\",\n \"metadata\": \"EQUIPMENT\",\n \"formModel\": {\n \"name\": \"equipment\",\n \"metadata\": \"EQUIPMENT\",\n \"slots\": [\n {\n \"name\": \"head\",\n \"metadata\": \"HEAD\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"body\",\n \"metadata\": \"BODY\",\n \"propertyRegex\": \"grn:.*\"\n },\n {\n \"name\": \"leg\",\n \"metadata\": \"LEG\",\n \"propertyRegex\": \"grn:.*\"\n }\n ]\n },\n \"initialMaxCapacity\": 20,\n \"maxCapacity\": 30\n }\n ]\n}" )
. withUploadToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . update_current_form_master (
formation . UpdateCurrentFormMasterRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_mode ( None )
. with_settings ( '{ \n "version": "2019-09-09", \n "moldModels": [ \n { \n "name": "party", \n "metadata": "PARTY", \n "formModel": { \n "name": "party", \n "metadata": "PARTY", \n "slots": [ \n { \n "name": "tank", \n "metadata": "TANK", \n "propertyRegex": "grn:.*" \n }, \n { \n "name": "healer", \n "metadata": "HEALER", \n "propertyRegex": "grn:.*" \n }, \n { \n "name": "dps_1", \n "metadata": "DPS", \n "propertyRegex": "grn:.*" \n }, \n { \n "name": "dps_2", \n "metadata": "DPS", \n "propertyRegex": "grn:.*" \n } \n ] \n }, \n "initialMaxCapacity": 10, \n "maxCapacity": 20 \n }, \n { \n "name": "equipment", \n "metadata": "EQUIPMENT", \n "formModel": { \n "name": "equipment", \n "metadata": "EQUIPMENT", \n "slots": [ \n { \n "name": "head", \n "metadata": "HEAD", \n "propertyRegex": "grn:.*" \n }, \n { \n "name": "body", \n "metadata": "BODY", \n "propertyRegex": "grn:.*" \n }, \n { \n "name": "leg", \n "metadata": "LEG", \n "propertyRegex": "grn:.*" \n } \n ] \n }, \n "initialMaxCapacity": 20, \n "maxCapacity": 30 \n } \n ] \n }' )
. with_upload_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.update_current_form_master ({
namespaceName = "namespace-0001" ,
mode = nil ,
settings = "{ \n " version ": " 2019 - 09 - 09 ", \n " moldModels ": [ \n { \n " name ": " party ", \n " metadata ": " PARTY ", \n " formModel ": { \n " name ": " party ", \n " metadata ": " PARTY ", \n " slots ": [ \n { \n " name ": " tank ", \n " metadata ": " TANK ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " healer ", \n " metadata ": " HEALER ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " dps_1 ", \n " metadata ": " DPS ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " dps_2 ", \n " metadata ": " DPS ", \n " propertyRegex ": " grn :. * " \n } \n ] \n }, \n " initialMaxCapacity ": 10, \n " maxCapacity ": 20 \n }, \n { \n " name ": " equipment ", \n " metadata ": " EQUIPMENT ", \n " formModel ": { \n " name ": " equipment ", \n " metadata ": " EQUIPMENT ", \n " slots ": [ \n { \n " name ": " head ", \n " metadata ": " HEAD ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " body ", \n " metadata ": " BODY ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " leg ", \n " metadata ": " LEG ", \n " propertyRegex ": " grn :. * " \n } \n ] \n }, \n " initialMaxCapacity ": 20, \n " maxCapacity ": 30 \n } \n ] \n }" ,
uploadToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.update_current_form_master_async ({
namespaceName = "namespace-0001" ,
mode = nil ,
settings = "{ \n " version ": " 2019 - 09 - 09 ", \n " moldModels ": [ \n { \n " name ": " party ", \n " metadata ": " PARTY ", \n " formModel ": { \n " name ": " party ", \n " metadata ": " PARTY ", \n " slots ": [ \n { \n " name ": " tank ", \n " metadata ": " TANK ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " healer ", \n " metadata ": " HEALER ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " dps_1 ", \n " metadata ": " DPS ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " dps_2 ", \n " metadata ": " DPS ", \n " propertyRegex ": " grn :. * " \n } \n ] \n }, \n " initialMaxCapacity ": 10, \n " maxCapacity ": 20 \n }, \n { \n " name ": " equipment ", \n " metadata ": " EQUIPMENT ", \n " formModel ": { \n " name ": " equipment ", \n " metadata ": " EQUIPMENT ", \n " slots ": [ \n { \n " name ": " head ", \n " metadata ": " HEAD ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " body ", \n " metadata ": " BODY ", \n " propertyRegex ": " grn :. * " \n }, \n { \n " name ": " leg ", \n " metadata ": " LEG ", \n " propertyRegex ": " grn :. * " \n } \n ] \n }, \n " initialMaxCapacity ": 20, \n " maxCapacity ": 30 \n } \n ] \n }" ,
uploadToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; Updates the currently available form settings
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name checkoutSetting GitHubCheckoutSetting ✓ Setup to check out master data from GitHub
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . UpdateCurrentFormMasterFromGitHub (
& formation . UpdateCurrentFormMasterFromGitHubRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
CheckoutSetting : & formation . GitHubCheckoutSetting {
ApiKeyId : pointy . String ( "apiKeyId-0001" ),
RepositoryName : pointy . String ( "gs2io/master-data" ),
SourcePath : pointy . String ( "path/to/file.json" ),
ReferenceType : pointy . String ( "branch" ),
BranchName : pointy . String ( "develop" ),
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\UpdateCurrentFormMasterFromGitHubRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateCurrentFormMasterFromGitHub (
( new UpdateCurrentFormMasterFromGitHubRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withCheckoutSetting (( new GitHubCheckoutSetting ())
-> withApiKeyId ( "apiKeyId-0001" )
-> withRepositoryName ( "gs2io/master-data" )
-> withSourcePath ( "path/to/file.json" )
-> withReferenceType ( "branch" )
-> withBranchName ( "develop" )
)
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.UpdateCurrentFormMasterFromGitHubRequest ;
import io.gs2.formation.result.UpdateCurrentFormMasterFromGitHubResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
UpdateCurrentFormMasterFromGitHubResult result = client . updateCurrentFormMasterFromGitHub (
new UpdateCurrentFormMasterFromGitHubRequest ()
. withNamespaceName ( "namespace-0001" )
. withCheckoutSetting ( new GitHubCheckoutSetting ()
. withApiKeyId ( "apiKeyId-0001" )
. withRepositoryName ( "gs2io/master-data" )
. withSourcePath ( "path/to/file.json" )
. withReferenceType ( "branch" )
. withBranchName ( "develop" )
)
);
CurrentFormMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.UpdateCurrentFormMasterFromGitHubRequest ;
using Gs2.Gs2Formation.Result.UpdateCurrentFormMasterFromGitHubResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . UpdateCurrentFormMasterFromGitHubResult > asyncResult = null ;
yield return client . UpdateCurrentFormMasterFromGitHub (
new Gs2 . Gs2Formation . Request . UpdateCurrentFormMasterFromGitHubRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithCheckoutSetting ( new Gs2 . Gs2Formation . Model . GitHubCheckoutSetting ()
. WithApiKeyId ( "apiKeyId-0001" )
. WithRepositoryName ( "gs2io/master-data" )
. WithSourcePath ( "path/to/file.json" )
. WithReferenceType ( "branch" )
. WithBranchName ( "develop" )
),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . updateCurrentFormMasterFromGitHub (
new Gs2Formation . UpdateCurrentFormMasterFromGitHubRequest ()
. withNamespaceName ( "namespace-0001" )
. withCheckoutSetting ( new Gs2Formation . model . GitHubCheckoutSetting ()
. withApiKeyId ( "apiKeyId-0001" )
. withRepositoryName ( "gs2io/master-data" )
. withSourcePath ( "path/to/file.json" )
. withReferenceType ( "branch" )
. withBranchName ( "develop" )
)
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . update_current_form_master_from_git_hub (
formation . UpdateCurrentFormMasterFromGitHubRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_checkout_setting ( formation . GitHubCheckoutSetting ()
. with_api_key_id ( 'apiKeyId-0001' )
. with_repository_name ( 'gs2io/master-data' )
. with_source_path ( 'path/to/file.json' )
. with_reference_type ( 'branch' )
. with_branch_name ( 'develop' )
)
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.update_current_form_master_from_git_hub ({
namespaceName = "namespace-0001" ,
checkoutSetting = {
api_key_id = "apiKeyId-0001" ,
repository_name = "gs2io/master-data" ,
source_path = "path/to/file.json" ,
reference_type = "branch" ,
branch_name = "develop" ,
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.update_current_form_master_from_git_hub_async ({
namespaceName = "namespace-0001" ,
checkoutSetting = {
api_key_id = "apiKeyId-0001" ,
repository_name = "gs2io/master-data" ,
source_path = "path/to/file.json" ,
reference_type = "branch" ,
branch_name = "develop" ,
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; describeMolds Get list of form storage area
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired
Result Type Description items List<Mold> List of form storage area nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribeMolds (
& formation . DescribeMoldsRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribeMoldsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeMolds (
( new DescribeMoldsRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribeMoldsRequest ;
import io.gs2.formation.result.DescribeMoldsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribeMoldsResult result = client . describeMolds (
new DescribeMoldsRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPageToken ( null )
. withLimit ( null )
);
List < Mold > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribeMoldsRequest ;
using Gs2.Gs2Formation.Result.DescribeMoldsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribeMoldsResult > asyncResult = null ;
yield return client . DescribeMolds (
new Gs2 . Gs2Formation . Request . DescribeMoldsRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describeMolds (
new Gs2Formation . DescribeMoldsRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_molds (
formation . DescribeMoldsRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_molds ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_molds_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; describeMoldsByUserId Get list of form storage area by specifying user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description items List<Mold> List of form storage area nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribeMoldsByUserId (
& formation . DescribeMoldsByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
PageToken : nil ,
Limit : nil ,
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribeMoldsByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeMoldsByUserId (
( new DescribeMoldsByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withPageToken ( null )
-> withLimit ( null )
-> withTimeOffsetToken ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribeMoldsByUserIdRequest ;
import io.gs2.formation.result.DescribeMoldsByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribeMoldsByUserIdResult result = client . describeMoldsByUserId (
new DescribeMoldsByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
List < Mold > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribeMoldsByUserIdRequest ;
using Gs2.Gs2Formation.Result.DescribeMoldsByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribeMoldsByUserIdResult > asyncResult = null ;
yield return client . DescribeMoldsByUserId (
new Gs2 . Gs2Formation . Request . DescribeMoldsByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithPageToken ( null )
. WithLimit ( null )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describeMoldsByUserId (
new Gs2Formation . DescribeMoldsByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_molds_by_user_id (
formation . DescribeMoldsByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_page_token ( None )
. with_limit ( None )
. with_time_offset_token ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_molds_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_molds_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; getMold Retrieve form storage area
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token moldModelName string ✓ ~ 128 chars Form storage area model name
Result Type Description item Mold Form storage area moldModel MoldModel Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetMold (
& formation . GetMoldRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
moldModel := result . MoldModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetMoldRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getMold (
( new GetMoldRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withMoldModelName ( "mold-0001" )
);
$item = $result -> getItem ();
$moldModel = $result -> getMoldModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetMoldRequest ;
import io.gs2.formation.result.GetMoldResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetMoldResult result = client . getMold (
new GetMoldRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
);
Mold item = result . getItem ();
MoldModel moldModel = result . getMoldModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetMoldRequest ;
using Gs2.Gs2Formation.Result.GetMoldResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetMoldResult > asyncResult = null ;
yield return client . GetMold (
new Gs2 . Gs2Formation . Request . GetMoldRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithMoldModelName ( "mold-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var moldModel = result . MoldModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getMold (
new Gs2Formation . GetMoldRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
);
const item = result . getItem ();
const moldModel = result . getMoldModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_mold (
formation . GetMoldRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_mold_model_name ( 'mold-0001' )
)
item = result . item
mold_model = result . mold_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_mold ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_mold_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; getMoldByUserId Retrieve form storage area by specifying the user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description item Mold Form storage area moldModel MoldModel Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetMoldByUserId (
& formation . GetMoldByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
moldModel := result . MoldModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetMoldByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getMoldByUserId (
( new GetMoldByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$moldModel = $result -> getMoldModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetMoldByUserIdRequest ;
import io.gs2.formation.result.GetMoldByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetMoldByUserIdResult result = client . getMoldByUserId (
new GetMoldByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withTimeOffsetToken ( null )
);
Mold item = result . getItem ();
MoldModel moldModel = result . getMoldModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetMoldByUserIdRequest ;
using Gs2.Gs2Formation.Result.GetMoldByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetMoldByUserIdResult > asyncResult = null ;
yield return client . GetMoldByUserId (
new Gs2 . Gs2Formation . Request . GetMoldByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var moldModel = result . MoldModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getMoldByUserId (
new Gs2Formation . GetMoldByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const moldModel = result . getMoldModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_mold_by_user_id (
formation . GetMoldByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_time_offset_token ( None )
)
item = result . item
mold_model = result . mold_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_mold_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_mold_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; setMoldCapacityByUserId Set capacity size with specified user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name capacity int ✓ ~ 2147483646 Current Capacity timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description item Mold Form storage area with updated capacity old Mold Form storage area before updating capacity moldModel MoldModel Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SetMoldCapacityByUserId (
& formation . SetMoldCapacityByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Capacity : pointy . Int32 ( 10 ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
old := result . Old
moldModel := result . MoldModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SetMoldCapacityByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> setMoldCapacityByUserId (
( new SetMoldCapacityByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withCapacity ( 10 )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$old = $result -> getOld ();
$moldModel = $result -> getMoldModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SetMoldCapacityByUserIdRequest ;
import io.gs2.formation.result.SetMoldCapacityByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SetMoldCapacityByUserIdResult result = client . setMoldCapacityByUserId (
new SetMoldCapacityByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withCapacity ( 10 )
. withTimeOffsetToken ( null )
);
Mold item = result . getItem ();
Mold old = result . getOld ();
MoldModel moldModel = result . getMoldModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SetMoldCapacityByUserIdRequest ;
using Gs2.Gs2Formation.Result.SetMoldCapacityByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SetMoldCapacityByUserIdResult > asyncResult = null ;
yield return client . SetMoldCapacityByUserId (
new Gs2 . Gs2Formation . Request . SetMoldCapacityByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithCapacity ( 10 )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var old = result . Old ;
var moldModel = result . MoldModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . setMoldCapacityByUserId (
new Gs2Formation . SetMoldCapacityByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withCapacity ( 10 )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const old = result . getOld ();
const moldModel = result . getMoldModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . set_mold_capacity_by_user_id (
formation . SetMoldCapacityByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_capacity ( 10 )
. with_time_offset_token ( None )
)
item = result . item
old = result . old
mold_model = result . mold_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.set_mold_capacity_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
capacity = 10 ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
old = result.old ;
moldModel = result.moldModel ; client = gs2 ( 'formation' )
api_result_handler = client.set_mold_capacity_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
capacity = 10 ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
old = result.old ;
moldModel = result.moldModel ; addMoldCapacityByUserId Add capacity size with user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name capacity int ✓ ~ 2147483646 Current Capacity timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description item Mold Form storage area with updated capacity moldModel MoldModel Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . AddMoldCapacityByUserId (
& formation . AddMoldCapacityByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Capacity : pointy . Int32 ( 10 ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
moldModel := result . MoldModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\AddMoldCapacityByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> addMoldCapacityByUserId (
( new AddMoldCapacityByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withCapacity ( 10 )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$moldModel = $result -> getMoldModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.AddMoldCapacityByUserIdRequest ;
import io.gs2.formation.result.AddMoldCapacityByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
AddMoldCapacityByUserIdResult result = client . addMoldCapacityByUserId (
new AddMoldCapacityByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withCapacity ( 10 )
. withTimeOffsetToken ( null )
);
Mold item = result . getItem ();
MoldModel moldModel = result . getMoldModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.AddMoldCapacityByUserIdRequest ;
using Gs2.Gs2Formation.Result.AddMoldCapacityByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . AddMoldCapacityByUserIdResult > asyncResult = null ;
yield return client . AddMoldCapacityByUserId (
new Gs2 . Gs2Formation . Request . AddMoldCapacityByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithCapacity ( 10 )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var moldModel = result . MoldModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . addMoldCapacityByUserId (
new Gs2Formation . AddMoldCapacityByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withCapacity ( 10 )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const moldModel = result . getMoldModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . add_mold_capacity_by_user_id (
formation . AddMoldCapacityByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_capacity ( 10 )
. with_time_offset_token ( None )
)
item = result . item
mold_model = result . mold_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.add_mold_capacity_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
capacity = 10 ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; client = gs2 ( 'formation' )
api_result_handler = client.add_mold_capacity_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
capacity = 10 ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; subMoldCapacity Subtract capacity size
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token moldModelName string ✓ ~ 128 chars Form storage area model name capacity int ✓ ~ 2147483646 Current Capacity
Result Type Description item Mold Form storage area with updated capacities moldModel MoldModel Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SubMoldCapacity (
& formation . SubMoldCapacityRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Capacity : pointy . Int32 ( 10 ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
moldModel := result . MoldModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SubMoldCapacityRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> subMoldCapacity (
( new SubMoldCapacityRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withMoldModelName ( "mold-0001" )
-> withCapacity ( 10 )
);
$item = $result -> getItem ();
$moldModel = $result -> getMoldModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SubMoldCapacityRequest ;
import io.gs2.formation.result.SubMoldCapacityResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SubMoldCapacityResult result = client . subMoldCapacity (
new SubMoldCapacityRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withCapacity ( 10 )
);
Mold item = result . getItem ();
MoldModel moldModel = result . getMoldModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SubMoldCapacityRequest ;
using Gs2.Gs2Formation.Result.SubMoldCapacityResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SubMoldCapacityResult > asyncResult = null ;
yield return client . SubMoldCapacity (
new Gs2 . Gs2Formation . Request . SubMoldCapacityRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithMoldModelName ( "mold-0001" )
. WithCapacity ( 10 ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var moldModel = result . MoldModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . subMoldCapacity (
new Gs2Formation . SubMoldCapacityRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withCapacity ( 10 )
);
const item = result . getItem ();
const moldModel = result . getMoldModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . sub_mold_capacity (
formation . SubMoldCapacityRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_capacity ( 10 )
)
item = result . item
mold_model = result . mold_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.sub_mold_capacity ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
capacity = 10 ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; client = gs2 ( 'formation' )
api_result_handler = client.sub_mold_capacity_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
capacity = 10 ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; subMoldCapacityByUserId Subtract capacity size by specifying user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name capacity int ✓ ~ 2147483646 Current Capacity timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description item Mold Form storage area with updated capacities moldModel MoldModel Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SubMoldCapacityByUserId (
& formation . SubMoldCapacityByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Capacity : pointy . Int32 ( 10 ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
moldModel := result . MoldModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SubMoldCapacityByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> subMoldCapacityByUserId (
( new SubMoldCapacityByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withCapacity ( 10 )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$moldModel = $result -> getMoldModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SubMoldCapacityByUserIdRequest ;
import io.gs2.formation.result.SubMoldCapacityByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SubMoldCapacityByUserIdResult result = client . subMoldCapacityByUserId (
new SubMoldCapacityByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withCapacity ( 10 )
. withTimeOffsetToken ( null )
);
Mold item = result . getItem ();
MoldModel moldModel = result . getMoldModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SubMoldCapacityByUserIdRequest ;
using Gs2.Gs2Formation.Result.SubMoldCapacityByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SubMoldCapacityByUserIdResult > asyncResult = null ;
yield return client . SubMoldCapacityByUserId (
new Gs2 . Gs2Formation . Request . SubMoldCapacityByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithCapacity ( 10 )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var moldModel = result . MoldModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . subMoldCapacityByUserId (
new Gs2Formation . SubMoldCapacityByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withCapacity ( 10 )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const moldModel = result . getMoldModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . sub_mold_capacity_by_user_id (
formation . SubMoldCapacityByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_capacity ( 10 )
. with_time_offset_token ( None )
)
item = result . item
mold_model = result . mold_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.sub_mold_capacity_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
capacity = 10 ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; client = gs2 ( 'formation' )
api_result_handler = client.sub_mold_capacity_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
capacity = 10 ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; deleteMold Delete form storage area
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token moldModelName string ✓ ~ 128 chars Form storage area model name
Result Type Description item Mold Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeleteMold (
& formation . DeleteMoldRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeleteMoldRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteMold (
( new DeleteMoldRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withMoldModelName ( "mold-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeleteMoldRequest ;
import io.gs2.formation.result.DeleteMoldResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeleteMoldResult result = client . deleteMold (
new DeleteMoldRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
);
Mold item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeleteMoldRequest ;
using Gs2.Gs2Formation.Result.DeleteMoldResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeleteMoldResult > asyncResult = null ;
yield return client . DeleteMold (
new Gs2 . Gs2Formation . Request . DeleteMoldRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithMoldModelName ( "mold-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deleteMold (
new Gs2Formation . DeleteMoldRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_mold (
formation . DeleteMoldRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_mold_model_name ( 'mold-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_mold ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.delete_mold_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; deleteMoldByUserId Delete form storage area with user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description item Mold Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeleteMoldByUserId (
& formation . DeleteMoldByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeleteMoldByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteMoldByUserId (
( new DeleteMoldByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeleteMoldByUserIdRequest ;
import io.gs2.formation.result.DeleteMoldByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeleteMoldByUserIdResult result = client . deleteMoldByUserId (
new DeleteMoldByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withTimeOffsetToken ( null )
);
Mold item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeleteMoldByUserIdRequest ;
using Gs2.Gs2Formation.Result.DeleteMoldByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeleteMoldByUserIdResult > asyncResult = null ;
yield return client . DeleteMoldByUserId (
new Gs2 . Gs2Formation . Request . DeleteMoldByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deleteMoldByUserId (
new Gs2Formation . DeleteMoldByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_mold_by_user_id (
formation . DeleteMoldByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_mold_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; client = gs2 ( 'formation' )
api_result_handler = client.delete_mold_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ; addCapacityByStampSheet Execute capacity size addition as acquire action
Request Type Condition Require Default Limitation Description stampSheet string ✓ ~ 5242880 chars Transaction keyId string ✓ ~ 1024 chars encryption key GRN
Result Type Description item Mold Form storage area after capacity addition moldModel MoldModel Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . AddCapacityByStampSheet (
& formation . AddCapacityByStampSheetRequest {
StampSheet : pointy . String ( "stampSheet" ),
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
moldModel := result . MoldModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\AddCapacityByStampSheetRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> addCapacityByStampSheet (
( new AddCapacityByStampSheetRequest ())
-> withStampSheet ( "stampSheet" )
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$moldModel = $result -> getMoldModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.AddCapacityByStampSheetRequest ;
import io.gs2.formation.result.AddCapacityByStampSheetResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
AddCapacityByStampSheetResult result = client . addCapacityByStampSheet (
new AddCapacityByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
Mold item = result . getItem ();
MoldModel moldModel = result . getMoldModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.AddCapacityByStampSheetRequest ;
using Gs2.Gs2Formation.Result.AddCapacityByStampSheetResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . AddCapacityByStampSheetResult > asyncResult = null ;
yield return client . AddCapacityByStampSheet (
new Gs2 . Gs2Formation . Request . AddCapacityByStampSheetRequest ()
. WithStampSheet ( "stampSheet" )
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var moldModel = result . MoldModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . addCapacityByStampSheet (
new Gs2Formation . AddCapacityByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const moldModel = result . getMoldModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . add_capacity_by_stamp_sheet (
formation . AddCapacityByStampSheetRequest ()
. with_stamp_sheet ( 'stampSheet' )
. with_key_id ( 'key-0001' )
)
item = result . item
mold_model = result . mold_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.add_capacity_by_stamp_sheet ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; client = gs2 ( 'formation' )
api_result_handler = client.add_capacity_by_stamp_sheet_async ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ; subCapacityByStampTask Execute capacity size subtraction as consume action
Request Type Condition Require Default Limitation Description stampTask string ✓ ~ 5242880 chars Consume Action keyId string ✓ ~ 1024 chars encryption key GRN
Result Type Description item Mold Form storage area after capacity subtraction moldModel MoldModel Form storage area newContextStack string Request of context in which consume action execution results are recorded
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SubCapacityByStampTask (
& formation . SubCapacityByStampTaskRequest {
StampTask : pointy . String ( "stampTask" ),
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
moldModel := result . MoldModel
newContextStack := result . NewContextStack use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SubCapacityByStampTaskRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> subCapacityByStampTask (
( new SubCapacityByStampTaskRequest ())
-> withStampTask ( "stampTask" )
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$moldModel = $result -> getMoldModel ();
$newContextStack = $result -> getNewContextStack ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SubCapacityByStampTaskRequest ;
import io.gs2.formation.result.SubCapacityByStampTaskResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SubCapacityByStampTaskResult result = client . subCapacityByStampTask (
new SubCapacityByStampTaskRequest ()
. withStampTask ( "stampTask" )
. withKeyId ( "key-0001" )
);
Mold item = result . getItem ();
MoldModel moldModel = result . getMoldModel ();
String newContextStack = result . getNewContextStack ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SubCapacityByStampTaskRequest ;
using Gs2.Gs2Formation.Result.SubCapacityByStampTaskResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SubCapacityByStampTaskResult > asyncResult = null ;
yield return client . SubCapacityByStampTask (
new Gs2 . Gs2Formation . Request . SubCapacityByStampTaskRequest ()
. WithStampTask ( "stampTask" )
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var moldModel = result . MoldModel ;
var newContextStack = result . NewContextStack ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . subCapacityByStampTask (
new Gs2Formation . SubCapacityByStampTaskRequest ()
. withStampTask ( "stampTask" )
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const moldModel = result . getMoldModel ();
const newContextStack = result . getNewContextStack ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . sub_capacity_by_stamp_task (
formation . SubCapacityByStampTaskRequest ()
. with_stamp_task ( 'stampTask' )
. with_key_id ( 'key-0001' )
)
item = result . item
mold_model = result . mold_model
new_context_stack = result . new_context_stack
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.sub_capacity_by_stamp_task ({
stampTask = "stampTask" ,
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ;
newContextStack = result.newContextStack ; client = gs2 ( 'formation' )
api_result_handler = client.sub_capacity_by_stamp_task_async ({
stampTask = "stampTask" ,
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
moldModel = result.moldModel ;
newContextStack = result.newContextStack ; setCapacityByStampSheet Execute capacity size setting as acquire action
Request Type Condition Require Default Limitation Description stampSheet string ✓ ~ 5242880 chars Transaction keyId string ✓ ~ 1024 chars encryption key GRN
Result Type Description item Mold Form storage area after update old Mold Form storage area before update moldModel MoldModel Form storage area
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SetCapacityByStampSheet (
& formation . SetCapacityByStampSheetRequest {
StampSheet : pointy . String ( "stampSheet" ),
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
old := result . Old
moldModel := result . MoldModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SetCapacityByStampSheetRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> setCapacityByStampSheet (
( new SetCapacityByStampSheetRequest ())
-> withStampSheet ( "stampSheet" )
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$old = $result -> getOld ();
$moldModel = $result -> getMoldModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SetCapacityByStampSheetRequest ;
import io.gs2.formation.result.SetCapacityByStampSheetResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SetCapacityByStampSheetResult result = client . setCapacityByStampSheet (
new SetCapacityByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
Mold item = result . getItem ();
Mold old = result . getOld ();
MoldModel moldModel = result . getMoldModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SetCapacityByStampSheetRequest ;
using Gs2.Gs2Formation.Result.SetCapacityByStampSheetResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SetCapacityByStampSheetResult > asyncResult = null ;
yield return client . SetCapacityByStampSheet (
new Gs2 . Gs2Formation . Request . SetCapacityByStampSheetRequest ()
. WithStampSheet ( "stampSheet" )
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var old = result . Old ;
var moldModel = result . MoldModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . setCapacityByStampSheet (
new Gs2Formation . SetCapacityByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const old = result . getOld ();
const moldModel = result . getMoldModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . set_capacity_by_stamp_sheet (
formation . SetCapacityByStampSheetRequest ()
. with_stamp_sheet ( 'stampSheet' )
. with_key_id ( 'key-0001' )
)
item = result . item
old = result . old
mold_model = result . mold_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.set_capacity_by_stamp_sheet ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
old = result.old ;
moldModel = result.moldModel ; client = gs2 ( 'formation' )
api_result_handler = client.set_capacity_by_stamp_sheet_async ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
old = result.old ;
moldModel = result.moldModel ; Get list of forms
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name moldModelName string ✓ ~ 128 chars Mold Model Name accessToken string ✓ ~ 128 chars Access token pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired
Result Type Description items List<Form> List of Form nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribeForms (
& formation . DescribeFormsRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribeFormsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeForms (
( new DescribeFormsRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withMoldModelName ( "mold-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribeFormsRequest ;
import io.gs2.formation.result.DescribeFormsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribeFormsResult result = client . describeForms (
new DescribeFormsRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
. withAccessToken ( "accessToken-0001" )
. withPageToken ( null )
. withLimit ( null )
);
List < Form > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribeFormsRequest ;
using Gs2.Gs2Formation.Result.DescribeFormsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribeFormsResult > asyncResult = null ;
yield return client . DescribeForms (
new Gs2 . Gs2Formation . Request . DescribeFormsRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithMoldModelName ( "mold-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describeForms (
new Gs2Formation . DescribeFormsRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
. withAccessToken ( "accessToken-0001" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_forms (
formation . DescribeFormsRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_access_token ( 'accessToken-0001' )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_forms ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
accessToken = "accessToken-0001" ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_forms_async ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
accessToken = "accessToken-0001" ,
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; Get list of forms by user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name moldModelName string ✓ ~ 128 chars Mold Model Name userId string ✓ ~ 128 chars User Id pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description items List<Form> List of Form nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribeFormsByUserId (
& formation . DescribeFormsByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
UserId : pointy . String ( "user-0001" ),
PageToken : nil ,
Limit : nil ,
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribeFormsByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeFormsByUserId (
( new DescribeFormsByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withMoldModelName ( "mold-0001" )
-> withUserId ( "user-0001" )
-> withPageToken ( null )
-> withLimit ( null )
-> withTimeOffsetToken ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribeFormsByUserIdRequest ;
import io.gs2.formation.result.DescribeFormsByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribeFormsByUserIdResult result = client . describeFormsByUserId (
new DescribeFormsByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
. withUserId ( "user-0001" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
List < Form > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribeFormsByUserIdRequest ;
using Gs2.Gs2Formation.Result.DescribeFormsByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribeFormsByUserIdResult > asyncResult = null ;
yield return client . DescribeFormsByUserId (
new Gs2 . Gs2Formation . Request . DescribeFormsByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithMoldModelName ( "mold-0001" )
. WithUserId ( "user-0001" )
. WithPageToken ( null )
. WithLimit ( null )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describeFormsByUserId (
new Gs2Formation . DescribeFormsByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withMoldModelName ( "mold-0001" )
. withUserId ( "user-0001" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_forms_by_user_id (
formation . DescribeFormsByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_user_id ( 'user-0001' )
. with_page_token ( None )
. with_limit ( None )
. with_time_offset_token ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_forms_by_user_id ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
userId = "user-0001" ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_forms_by_user_id_async ({
namespaceName = "namespace-0001" ,
moldModelName = "mold-0001" ,
userId = "user-0001" ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; Get Form
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetForm (
& formation . GetFormRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetFormRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getForm (
( new GetFormRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetFormRequest ;
import io.gs2.formation.result.GetFormResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetFormResult result = client . getForm (
new GetFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
);
Form item = result . getItem ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetFormRequest ;
using Gs2.Gs2Formation.Result.GetFormResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetFormResult > asyncResult = null ;
yield return client . GetForm (
new Gs2 . Gs2Formation . Request . GetFormRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getForm (
new Gs2Formation . GetFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
);
const item = result . getItem ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_form (
formation . GetFormRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
)
item = result . item
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_form ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_form_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Get form by specifying user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetFormByUserId (
& formation . GetFormByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetFormByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getFormByUserId (
( new GetFormByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetFormByUserIdRequest ;
import io.gs2.formation.result.GetFormByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetFormByUserIdResult result = client . getFormByUserId (
new GetFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withTimeOffsetToken ( null )
);
Form item = result . getItem ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetFormByUserIdRequest ;
using Gs2.Gs2Formation.Result.GetFormByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetFormByUserIdResult > asyncResult = null ;
yield return client . GetFormByUserId (
new Gs2 . Gs2Formation . Request . GetFormByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getFormByUserId (
new Gs2Formation . GetFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_form_by_user_id (
formation . GetFormByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
. with_time_offset_token ( None )
)
item = result . item
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_form_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_form_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Retrieve signed forms
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area keyId string ✓ “grn:gs2:{region}:{ownerId}:key:default:key:default” ~ 1024 chars encryption key GRN
Result Type Description item Form Form body string Value to be signed signature string Signature mold Mold Form storage area moldModel MoldModel Form storage area model formModel FormModel Form Model
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetFormWithSignature (
& formation . GetFormWithSignatureRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
body := result . Body
signature := result . Signature
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetFormWithSignatureRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getFormWithSignature (
( new GetFormWithSignatureRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$body = $result -> getBody ();
$signature = $result -> getSignature ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetFormWithSignatureRequest ;
import io.gs2.formation.result.GetFormWithSignatureResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetFormWithSignatureResult result = client . getFormWithSignature (
new GetFormWithSignatureRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withKeyId ( "key-0001" )
);
Form item = result . getItem ();
String body = result . getBody ();
String signature = result . getSignature ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetFormWithSignatureRequest ;
using Gs2.Gs2Formation.Result.GetFormWithSignatureResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetFormWithSignatureResult > asyncResult = null ;
yield return client . GetFormWithSignature (
new Gs2 . Gs2Formation . Request . GetFormWithSignatureRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 )
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var body = result . Body ;
var signature = result . Signature ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getFormWithSignature (
new Gs2Formation . GetFormWithSignatureRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const body = result . getBody ();
const signature = result . getSignature ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_form_with_signature (
formation . GetFormWithSignatureRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
. with_key_id ( 'key-0001' )
)
item = result . item
body = result . body
signature = result . signature
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_form_with_signature ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
body = result.body ;
signature = result.signature ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_form_with_signature_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
body = result.body ;
signature = result.signature ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Retrieve signed form with user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area keyId string ✓ “grn:gs2:{region}:{ownerId}:key:default:key:default” ~ 1024 chars encryption key GRN timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description item Form Form body string Value to be signed signature string Signature mold Mold Form storage area moldModel MoldModel Form storage area model formModel FormModel Form Model
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetFormWithSignatureByUserId (
& formation . GetFormWithSignatureByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
KeyId : pointy . String ( "key-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
body := result . Body
signature := result . Signature
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetFormWithSignatureByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getFormWithSignatureByUserId (
( new GetFormWithSignatureByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
-> withKeyId ( "key-0001" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$body = $result -> getBody ();
$signature = $result -> getSignature ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetFormWithSignatureByUserIdRequest ;
import io.gs2.formation.result.GetFormWithSignatureByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetFormWithSignatureByUserIdResult result = client . getFormWithSignatureByUserId (
new GetFormWithSignatureByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withKeyId ( "key-0001" )
. withTimeOffsetToken ( null )
);
Form item = result . getItem ();
String body = result . getBody ();
String signature = result . getSignature ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetFormWithSignatureByUserIdRequest ;
using Gs2.Gs2Formation.Result.GetFormWithSignatureByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetFormWithSignatureByUserIdResult > asyncResult = null ;
yield return client . GetFormWithSignatureByUserId (
new Gs2 . Gs2Formation . Request . GetFormWithSignatureByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 )
. WithKeyId ( "key-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var body = result . Body ;
var signature = result . Signature ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getFormWithSignatureByUserId (
new Gs2Formation . GetFormWithSignatureByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withKeyId ( "key-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const body = result . getBody ();
const signature = result . getSignature ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_form_with_signature_by_user_id (
formation . GetFormWithSignatureByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
. with_key_id ( 'key-0001' )
. with_time_offset_token ( None )
)
item = result . item
body = result . body
signature = result . signature
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_form_with_signature_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
keyId = "key-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
body = result.body ;
signature = result.signature ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_form_with_signature_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
keyId = "key-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
body = result.body ;
signature = result.signature ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Set form
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area slots List<Slot> ✓ 1 ~ 10 items List of Slots
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SetForm (
& formation . SetFormRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
Slots : [] formation . Slot {
formation . Slot {
Name : pointy . String ( "slot-0001" ),
PropertyId : pointy . String ( "property-0001" ),
},
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SetFormRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> setForm (
( new SetFormRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
-> withSlots ([
( new Slot ())
-> withName ( "slot-0001" )
-> withPropertyId ( "property-0001" ),
])
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SetFormRequest ;
import io.gs2.formation.result.SetFormResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SetFormResult result = client . setForm (
new SetFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withSlots ( Arrays . asList (
new Slot ()
. withName ( "slot-0001" )
. withPropertyId ( "property-0001" )
))
);
Form item = result . getItem ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SetFormRequest ;
using Gs2.Gs2Formation.Result.SetFormResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SetFormResult > asyncResult = null ;
yield return client . SetForm (
new Gs2 . Gs2Formation . Request . SetFormRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 )
. WithSlots ( new Gs2 . Gs2Formation . Model . Slot [] {
new Gs2 . Gs2Formation . Model . Slot ()
. WithName ( "slot-0001" )
. WithPropertyId ( "property-0001" ),
}),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . setForm (
new Gs2Formation . SetFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withSlots ([
new Gs2Formation . model . Slot ()
. withName ( "slot-0001" )
. withPropertyId ( "property-0001" ),
])
);
const item = result . getItem ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . set_form (
formation . SetFormRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
. with_slots ([
formation . Slot ()
. with_name ( 'slot-0001' )
. with_property_id ( 'property-0001' ),
])
)
item = result . item
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.set_form ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
slots = {
{
name = "slot-0001" ,
property_id = "property-0001" ,
}
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.set_form_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
slots = {
{
name = "slot-0001" ,
property_id = "property-0001" ,
}
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Set form by specifying user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area slots List<Slot> ✓ 1 ~ 10 items List of Slots timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SetFormByUserId (
& formation . SetFormByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
Slots : [] formation . Slot {
formation . Slot {
Name : pointy . String ( "slot-0001" ),
PropertyId : pointy . String ( "grn:1001" ),
},
},
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SetFormByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> setFormByUserId (
( new SetFormByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
-> withSlots ([
( new \Gs2\Formation\Model\Slot ())
-> withName ( "slot-0001" )
-> withPropertyId ( "grn:1001" ),
])
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SetFormByUserIdRequest ;
import io.gs2.formation.result.SetFormByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SetFormByUserIdResult result = client . setFormByUserId (
new SetFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withSlots ( Arrays . asList (
new io . gs2 . formation . model . Slot ()
. withName ( "slot-0001" )
. withPropertyId ( "grn:1001" )
))
. withTimeOffsetToken ( null )
);
Form item = result . getItem ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SetFormByUserIdRequest ;
using Gs2.Gs2Formation.Result.SetFormByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SetFormByUserIdResult > asyncResult = null ;
yield return client . SetFormByUserId (
new Gs2 . Gs2Formation . Request . SetFormByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 )
. WithSlots ( new Gs2 . Gs2Formation . Model . Slot [] {
new Gs2 . Gs2Formation . Model . Slot ()
. WithName ( "slot-0001" )
. WithPropertyId ( "grn:1001" ),
})
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . setFormByUserId (
new Gs2Formation . SetFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withSlots ([
new Gs2Formation . model . Slot ()
. withName ( "slot-0001" )
. withPropertyId ( "grn:1001" ),
])
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . set_form_by_user_id (
formation . SetFormByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
. with_slots ([
formation . Slot ()
. with_name ( 'slot-0001' )
. with_property_id ( 'grn:1001' ),
])
. with_time_offset_token ( None )
)
item = result . item
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.set_form_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
slots = {
{
name = "slot-0001" ,
propertyId = "grn:1001" ,
}
},
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.set_form_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
slots = {
{
name = "slot-0001" ,
propertyId = "grn:1001" ,
}
},
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Update forms with signed slots
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area slots List<SlotWithSignature> ✓ 1 ~ 10 items List of Slot keyId string ✓ “grn:gs2:{region}:{ownerId}:key:default:key:default” ~ 1024 chars encryption key GRN
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SetFormWithSignature (
& formation . SetFormWithSignatureRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
Slots : [] formation . SlotWithSignature {
formation . SlotWithSignature {
Name : pointy . String ( "slot-0001" ),
PropertyType : pointy . String ( "gs2_dictionary" ),
Body : pointy . String ( "body" ),
Signature : pointy . String ( "signature" ),
},
},
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SetFormWithSignatureRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> setFormWithSignature (
( new SetFormWithSignatureRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
-> withSlots ([
( new SlotWithSignature ())
-> withName ( "slot-0001" )
-> withPropertyType ( "gs2_dictionary" )
-> withBody ( "body" )
-> withSignature ( "signature" ),
])
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SetFormWithSignatureRequest ;
import io.gs2.formation.result.SetFormWithSignatureResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SetFormWithSignatureResult result = client . setFormWithSignature (
new SetFormWithSignatureRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withSlots ( Arrays . asList (
new SlotWithSignature ()
. withName ( "slot-0001" )
. withPropertyType ( "gs2_dictionary" )
. withBody ( "body" )
. withSignature ( "signature" )
))
. withKeyId ( "key-0001" )
);
Form item = result . getItem ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SetFormWithSignatureRequest ;
using Gs2.Gs2Formation.Result.SetFormWithSignatureResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SetFormWithSignatureResult > asyncResult = null ;
yield return client . SetFormWithSignature (
new Gs2 . Gs2Formation . Request . SetFormWithSignatureRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 )
. WithSlots ( new Gs2 . Gs2Formation . Model . SlotWithSignature [] {
new Gs2 . Gs2Formation . Model . SlotWithSignature ()
. WithName ( "slot-0001" )
. WithPropertyType ( "gs2_dictionary" )
. WithBody ( "body" )
. WithSignature ( "signature" ),
})
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . setFormWithSignature (
new Gs2Formation . SetFormWithSignatureRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withSlots ([
new Gs2Formation . model . SlotWithSignature ()
. withName ( "slot-0001" )
. withPropertyType ( "gs2_dictionary" )
. withBody ( "body" )
. withSignature ( "signature" ),
])
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . set_form_with_signature (
formation . SetFormWithSignatureRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
. with_slots ([
formation . SlotWithSignature ()
. with_name ( 'slot-0001' )
. with_property_type ( 'gs2_dictionary' )
. with_body ( 'body' )
. with_signature ( 'signature' ),
])
. with_key_id ( 'key-0001' )
)
item = result . item
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.set_form_with_signature ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
slots = {
{
name = "slot-0001" ,
property_type = "gs2_dictionary" ,
body = "body" ,
signature = "signature" ,
}
},
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.set_form_with_signature_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
slots = {
{
name = "slot-0001" ,
property_type = "gs2_dictionary" ,
body = "body" ,
signature = "signature" ,
}
},
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Apply get action to form properties by specifying user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area acquireAction AcquireAction ✓ Get action to be applied to form properties config List<Config> [] ~ 1000 items List of Acquisition config timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description item Form Form mold Mold Form storage area transactionId string Issed transaction ID stampSheet string Stamp sheet stampSheetEncryptionKeyId string Cryptographic key GRN used for stamp sheet signature calculations autoRunStampSheet bool? Is transaction auto-execution enabled? atomicCommit bool? Transaction to commit atomically transaction string Issued transaction transactionResult TransactionResult Transaction execution result
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . AcquireActionsToFormProperties (
& formation . AcquireActionsToFormPropertiesRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
AcquireAction : & formation . AcquireAction {
Action : pointy . String ( "Gs2Experience:AddExperienceByUserId" ),
Request : pointy . String ( "{}" ),
},
Config : nil ,
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
transactionId := result . TransactionId
stampSheet := result . StampSheet
stampSheetEncryptionKeyId := result . StampSheetEncryptionKeyId
autoRunStampSheet := result . AutoRunStampSheet
atomicCommit := result . AtomicCommit
transaction := result . Transaction
transactionResult := result . TransactionResult use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\AcquireActionsToFormPropertiesRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> acquireActionsToFormProperties (
( new AcquireActionsToFormPropertiesRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
-> withAcquireAction (( new AcquireAction ())
-> withAction ( "Gs2Experience:AddExperienceByUserId" )
-> withRequest ( "{}" )
)
-> withConfig ( null )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$transactionId = $result -> getTransactionId ();
$stampSheet = $result -> getStampSheet ();
$stampSheetEncryptionKeyId = $result -> getStampSheetEncryptionKeyId ();
$autoRunStampSheet = $result -> getAutoRunStampSheet ();
$atomicCommit = $result -> getAtomicCommit ();
$transaction = $result -> getTransaction ();
$transactionResult = $result -> getTransactionResult ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.AcquireActionsToFormPropertiesRequest ;
import io.gs2.formation.result.AcquireActionsToFormPropertiesResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
AcquireActionsToFormPropertiesResult result = client . acquireActionsToFormProperties (
new AcquireActionsToFormPropertiesRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withAcquireAction ( new AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "{}" )
)
. withConfig ( null )
. withTimeOffsetToken ( null )
);
Form item = result . getItem ();
Mold mold = result . getMold ();
String transactionId = result . getTransactionId ();
String stampSheet = result . getStampSheet ();
String stampSheetEncryptionKeyId = result . getStampSheetEncryptionKeyId ();
boolean autoRunStampSheet = result . getAutoRunStampSheet ();
boolean atomicCommit = result . getAtomicCommit ();
String transaction = result . getTransaction ();
TransactionResult transactionResult = result . getTransactionResult ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.AcquireActionsToFormPropertiesRequest ;
using Gs2.Gs2Formation.Result.AcquireActionsToFormPropertiesResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . AcquireActionsToFormPropertiesResult > asyncResult = null ;
yield return client . AcquireActionsToFormProperties (
new Gs2 . Gs2Formation . Request . AcquireActionsToFormPropertiesRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 )
. WithAcquireAction ( new Gs2 . Core . Model . AcquireAction ()
. WithAction ( "Gs2Experience:AddExperienceByUserId" )
. WithRequest ( "{}" )
)
. WithConfig ( null )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var transactionId = result . TransactionId ;
var stampSheet = result . StampSheet ;
var stampSheetEncryptionKeyId = result . StampSheetEncryptionKeyId ;
var autoRunStampSheet = result . AutoRunStampSheet ;
var atomicCommit = result . AtomicCommit ;
var transaction = result . Transaction ;
var transactionResult = result . TransactionResult ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . acquireActionsToFormProperties (
new Gs2Formation . AcquireActionsToFormPropertiesRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withAcquireAction ( new Gs2Formation . model . AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "{}" )
)
. withConfig ( null )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const mold = result . getMold ();
const transactionId = result . getTransactionId ();
const stampSheet = result . getStampSheet ();
const stampSheetEncryptionKeyId = result . getStampSheetEncryptionKeyId ();
const autoRunStampSheet = result . getAutoRunStampSheet ();
const atomicCommit = result . getAtomicCommit ();
const transaction = result . getTransaction ();
const transactionResult = result . getTransactionResult ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . acquire_actions_to_form_properties (
formation . AcquireActionsToFormPropertiesRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
. with_acquire_action ( formation . AcquireAction ()
. with_action ( 'Gs2Experience:AddExperienceByUserId' )
. with_request ( ' {} ' )
)
. with_config ( None )
. with_time_offset_token ( None )
)
item = result . item
mold = result . mold
transaction_id = result . transaction_id
stamp_sheet = result . stamp_sheet
stamp_sheet_encryption_key_id = result . stamp_sheet_encryption_key_id
auto_run_stamp_sheet = result . auto_run_stamp_sheet
atomic_commit = result . atomic_commit
transaction = result . transaction
transaction_result = result . transaction_result
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.acquire_actions_to_form_properties ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
acquireAction = {
action = "Gs2Experience:AddExperienceByUserId" ,
request = "{}" ,
},
config = nil ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
transactionId = result.transactionId ;
stampSheet = result.stampSheet ;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId ;
autoRunStampSheet = result.autoRunStampSheet ;
atomicCommit = result.atomicCommit ;
transaction = result.transaction ;
transactionResult = result.transactionResult ; client = gs2 ( 'formation' )
api_result_handler = client.acquire_actions_to_form_properties_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
acquireAction = {
action = "Gs2Experience:AddExperienceByUserId" ,
request = "{}" ,
},
config = nil ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
transactionId = result.transactionId ;
stampSheet = result.stampSheet ;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId ;
autoRunStampSheet = result.autoRunStampSheet ;
atomicCommit = result.atomicCommit ;
transaction = result.transaction ;
transactionResult = result.transactionResult ; Delete form
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeleteForm (
& formation . DeleteFormRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeleteFormRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteForm (
( new DeleteFormRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeleteFormRequest ;
import io.gs2.formation.result.DeleteFormResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeleteFormResult result = client . deleteForm (
new DeleteFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
);
Form item = result . getItem ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeleteFormRequest ;
using Gs2.Gs2Formation.Result.DeleteFormResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeleteFormResult > asyncResult = null ;
yield return client . DeleteForm (
new Gs2 . Gs2Formation . Request . DeleteFormRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deleteForm (
new Gs2Formation . DeleteFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
);
const item = result . getItem ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_form (
formation . DeleteFormRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
)
item = result . item
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_form ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.delete_form_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Delete form with user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id moldModelName string ✓ ~ 128 chars Form storage area model name index int ✓ ~ 2147483646 Index of form storage area timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeleteFormByUserId (
& formation . DeleteFormByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
MoldModelName : pointy . String ( "mold-0001" ),
Index : pointy . Int32 ( 0 ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeleteFormByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteFormByUserId (
( new DeleteFormByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withMoldModelName ( "mold-0001" )
-> withIndex ( 0 )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeleteFormByUserIdRequest ;
import io.gs2.formation.result.DeleteFormByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeleteFormByUserIdResult result = client . deleteFormByUserId (
new DeleteFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withTimeOffsetToken ( null )
);
Form item = result . getItem ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeleteFormByUserIdRequest ;
using Gs2.Gs2Formation.Result.DeleteFormByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeleteFormByUserIdResult > asyncResult = null ;
yield return client . DeleteFormByUserId (
new Gs2 . Gs2Formation . Request . DeleteFormByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithMoldModelName ( "mold-0001" )
. WithIndex ( 0 )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deleteFormByUserId (
new Gs2Formation . DeleteFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withMoldModelName ( "mold-0001" )
. withIndex ( 0 )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_form_by_user_id (
formation . DeleteFormByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_mold_model_name ( 'mold-0001' )
. with_index ( 0 )
. with_time_offset_token ( None )
)
item = result . item
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_form_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.delete_form_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
moldModelName = "mold-0001" ,
index = 0 ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Execute the get action as an acquire action for the form properties
Request Type Condition Require Default Limitation Description stampSheet string ✓ ~ 5242880 chars Transaction keyId string ✓ ~ 1024 chars encryption key GRN
Result Type Description item Form Form mold Mold Form storage area transactionId string Issed transaction ID stampSheet string Stamp sheet stampSheetEncryptionKeyId string Cryptographic key GRN used for stamp sheet signature calculations autoRunStampSheet bool? Is transaction auto-execution enabled? atomicCommit bool? Transaction to commit atomically transaction string Issued transaction transactionResult TransactionResult Transaction execution result
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . AcquireActionToFormPropertiesByStampSheet (
& formation . AcquireActionToFormPropertiesByStampSheetRequest {
StampSheet : pointy . String ( "stampSheet" ),
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
transactionId := result . TransactionId
stampSheet := result . StampSheet
stampSheetEncryptionKeyId := result . StampSheetEncryptionKeyId
autoRunStampSheet := result . AutoRunStampSheet
atomicCommit := result . AtomicCommit
transaction := result . Transaction
transactionResult := result . TransactionResult use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\AcquireActionToFormPropertiesByStampSheetRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> acquireActionToFormPropertiesByStampSheet (
( new AcquireActionToFormPropertiesByStampSheetRequest ())
-> withStampSheet ( "stampSheet" )
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$transactionId = $result -> getTransactionId ();
$stampSheet = $result -> getStampSheet ();
$stampSheetEncryptionKeyId = $result -> getStampSheetEncryptionKeyId ();
$autoRunStampSheet = $result -> getAutoRunStampSheet ();
$atomicCommit = $result -> getAtomicCommit ();
$transaction = $result -> getTransaction ();
$transactionResult = $result -> getTransactionResult ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.AcquireActionToFormPropertiesByStampSheetRequest ;
import io.gs2.formation.result.AcquireActionToFormPropertiesByStampSheetResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
AcquireActionToFormPropertiesByStampSheetResult result = client . acquireActionToFormPropertiesByStampSheet (
new AcquireActionToFormPropertiesByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
Form item = result . getItem ();
Mold mold = result . getMold ();
String transactionId = result . getTransactionId ();
String stampSheet = result . getStampSheet ();
String stampSheetEncryptionKeyId = result . getStampSheetEncryptionKeyId ();
boolean autoRunStampSheet = result . getAutoRunStampSheet ();
boolean atomicCommit = result . getAtomicCommit ();
String transaction = result . getTransaction ();
TransactionResult transactionResult = result . getTransactionResult ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.AcquireActionToFormPropertiesByStampSheetRequest ;
using Gs2.Gs2Formation.Result.AcquireActionToFormPropertiesByStampSheetResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . AcquireActionToFormPropertiesByStampSheetResult > asyncResult = null ;
yield return client . AcquireActionToFormPropertiesByStampSheet (
new Gs2 . Gs2Formation . Request . AcquireActionToFormPropertiesByStampSheetRequest ()
. WithStampSheet ( "stampSheet" )
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var transactionId = result . TransactionId ;
var stampSheet = result . StampSheet ;
var stampSheetEncryptionKeyId = result . StampSheetEncryptionKeyId ;
var autoRunStampSheet = result . AutoRunStampSheet ;
var atomicCommit = result . AtomicCommit ;
var transaction = result . Transaction ;
var transactionResult = result . TransactionResult ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . acquireActionToFormPropertiesByStampSheet (
new Gs2Formation . AcquireActionToFormPropertiesByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const mold = result . getMold ();
const transactionId = result . getTransactionId ();
const stampSheet = result . getStampSheet ();
const stampSheetEncryptionKeyId = result . getStampSheetEncryptionKeyId ();
const autoRunStampSheet = result . getAutoRunStampSheet ();
const atomicCommit = result . getAtomicCommit ();
const transaction = result . getTransaction ();
const transactionResult = result . getTransactionResult ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . acquire_action_to_form_properties_by_stamp_sheet (
formation . AcquireActionToFormPropertiesByStampSheetRequest ()
. with_stamp_sheet ( 'stampSheet' )
. with_key_id ( 'key-0001' )
)
item = result . item
mold = result . mold
transaction_id = result . transaction_id
stamp_sheet = result . stamp_sheet
stamp_sheet_encryption_key_id = result . stamp_sheet_encryption_key_id
auto_run_stamp_sheet = result . auto_run_stamp_sheet
atomic_commit = result . atomic_commit
transaction = result . transaction
transaction_result = result . transaction_result
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.acquire_action_to_form_properties_by_stamp_sheet ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
transactionId = result.transactionId ;
stampSheet = result.stampSheet ;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId ;
autoRunStampSheet = result.autoRunStampSheet ;
atomicCommit = result.atomicCommit ;
transaction = result.transaction ;
transactionResult = result.transactionResult ; client = gs2 ( 'formation' )
api_result_handler = client.acquire_action_to_form_properties_by_stamp_sheet_async ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
transactionId = result.transactionId ;
stampSheet = result.stampSheet ;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId ;
autoRunStampSheet = result.autoRunStampSheet ;
atomicCommit = result.atomicCommit ;
transaction = result.transaction ;
transactionResult = result.transactionResult ; Execute the update as an acquire action
Request Type Condition Require Default Limitation Description stampSheet string ✓ ~ 5242880 chars Transaction keyId string ✓ ~ 1024 chars encryption key GRN
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SetFormByStampSheet (
& formation . SetFormByStampSheetRequest {
StampSheet : pointy . String ( "stampSheet" ),
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
mold := result . Mold
moldModel := result . MoldModel
formModel := result . FormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SetFormByStampSheetRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> setFormByStampSheet (
( new SetFormByStampSheetRequest ())
-> withStampSheet ( "stampSheet" )
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$mold = $result -> getMold ();
$moldModel = $result -> getMoldModel ();
$formModel = $result -> getFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SetFormByStampSheetRequest ;
import io.gs2.formation.result.SetFormByStampSheetResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SetFormByStampSheetResult result = client . setFormByStampSheet (
new SetFormByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
Form item = result . getItem ();
Mold mold = result . getMold ();
MoldModel moldModel = result . getMoldModel ();
FormModel formModel = result . getFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SetFormByStampSheetRequest ;
using Gs2.Gs2Formation.Result.SetFormByStampSheetResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SetFormByStampSheetResult > asyncResult = null ;
yield return client . SetFormByStampSheet (
new Gs2 . Gs2Formation . Request . SetFormByStampSheetRequest ()
. WithStampSheet ( "stampSheet" )
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var mold = result . Mold ;
var moldModel = result . MoldModel ;
var formModel = result . FormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . setFormByStampSheet (
new Gs2Formation . SetFormByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const mold = result . getMold ();
const moldModel = result . getMoldModel ();
const formModel = result . getFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . set_form_by_stamp_sheet (
formation . SetFormByStampSheetRequest ()
. with_stamp_sheet ( 'stampSheet' )
. with_key_id ( 'key-0001' )
)
item = result . item
mold = result . mold
mold_model = result . mold_model
form_model = result . form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.set_form_by_stamp_sheet ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; client = gs2 ( 'formation' )
api_result_handler = client.set_form_by_stamp_sheet_async ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
mold = result.mold ;
moldModel = result.moldModel ;
formModel = result.formModel ; Get list of property forms
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token propertyFormModelName string ✓ ~ 128 chars Property form model name pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired
Result Type Description items List<PropertyForm> List of PropertyForm nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribePropertyForms (
& formation . DescribePropertyFormsRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribePropertyFormsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describePropertyForms (
( new DescribePropertyFormsRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribePropertyFormsRequest ;
import io.gs2.formation.result.DescribePropertyFormsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribePropertyFormsResult result = client . describePropertyForms (
new DescribePropertyFormsRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPageToken ( null )
. withLimit ( null )
);
List < PropertyForm > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribePropertyFormsRequest ;
using Gs2.Gs2Formation.Result.DescribePropertyFormsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribePropertyFormsResult > asyncResult = null ;
yield return client . DescribePropertyForms (
new Gs2 . Gs2Formation . Request . DescribePropertyFormsRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describePropertyForms (
new Gs2Formation . DescribePropertyFormsRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_property_forms (
formation . DescribePropertyFormsRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_property_forms ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_property_forms_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; Get list of property forms by user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id propertyFormModelName string ✓ ~ 128 chars Property form model name pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description items List<PropertyForm> List of PropertyForm nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DescribePropertyFormsByUserId (
& formation . DescribePropertyFormsByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PageToken : nil ,
Limit : nil ,
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DescribePropertyFormsByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describePropertyFormsByUserId (
( new DescribePropertyFormsByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPageToken ( null )
-> withLimit ( null )
-> withTimeOffsetToken ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DescribePropertyFormsByUserIdRequest ;
import io.gs2.formation.result.DescribePropertyFormsByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DescribePropertyFormsByUserIdResult result = client . describePropertyFormsByUserId (
new DescribePropertyFormsByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
List < PropertyForm > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DescribePropertyFormsByUserIdRequest ;
using Gs2.Gs2Formation.Result.DescribePropertyFormsByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DescribePropertyFormsByUserIdResult > asyncResult = null ;
yield return client . DescribePropertyFormsByUserId (
new Gs2 . Gs2Formation . Request . DescribePropertyFormsByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPageToken ( null )
. WithLimit ( null )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . describePropertyFormsByUserId (
new Gs2Formation . DescribePropertyFormsByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . describe_property_forms_by_user_id (
formation . DescribePropertyFormsByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_page_token ( None )
. with_limit ( None )
. with_time_offset_token ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.describe_property_forms_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; client = gs2 ( 'formation' )
api_result_handler = client.describe_property_forms_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ; Get Property Form
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token propertyFormModelName string ✓ ~ 128 chars Property form model namee propertyId string ✓ ~ 1024 chars Property Id
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetPropertyForm (
& formation . GetPropertyFormRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
propertyFormModel := result . PropertyFormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetPropertyFormRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getPropertyForm (
( new GetPropertyFormRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
);
$item = $result -> getItem ();
$propertyFormModel = $result -> getPropertyFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetPropertyFormRequest ;
import io.gs2.formation.result.GetPropertyFormResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetPropertyFormResult result = client . getPropertyForm (
new GetPropertyFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
);
PropertyForm item = result . getItem ();
PropertyFormModel propertyFormModel = result . getPropertyFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetPropertyFormRequest ;
using Gs2.Gs2Formation.Result.GetPropertyFormResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetPropertyFormResult > asyncResult = null ;
yield return client . GetPropertyForm (
new Gs2 . Gs2Formation . Request . GetPropertyFormRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var propertyFormModel = result . PropertyFormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getPropertyForm (
new Gs2Formation . GetPropertyFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
);
const item = result . getItem ();
const propertyFormModel = result . getPropertyFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_property_form (
formation . GetPropertyFormRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
)
item = result . item
property_form_model = result . property_form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_property_form ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_property_form_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; Get property form by specifying user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id propertyFormModelName string ✓ ~ 128 chars Property form model namee propertyId string ✓ ~ 1024 chars Property Id timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetPropertyFormByUserId (
& formation . GetPropertyFormByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
propertyFormModel := result . PropertyFormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetPropertyFormByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getPropertyFormByUserId (
( new GetPropertyFormByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$propertyFormModel = $result -> getPropertyFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetPropertyFormByUserIdRequest ;
import io.gs2.formation.result.GetPropertyFormByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetPropertyFormByUserIdResult result = client . getPropertyFormByUserId (
new GetPropertyFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withTimeOffsetToken ( null )
);
PropertyForm item = result . getItem ();
PropertyFormModel propertyFormModel = result . getPropertyFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetPropertyFormByUserIdRequest ;
using Gs2.Gs2Formation.Result.GetPropertyFormByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetPropertyFormByUserIdResult > asyncResult = null ;
yield return client . GetPropertyFormByUserId (
new Gs2 . Gs2Formation . Request . GetPropertyFormByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var propertyFormModel = result . PropertyFormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getPropertyFormByUserId (
new Gs2Formation . GetPropertyFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const propertyFormModel = result . getPropertyFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_property_form_by_user_id (
formation . GetPropertyFormByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
. with_time_offset_token ( None )
)
item = result . item
property_form_model = result . property_form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_property_form_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_property_form_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; Retrieve signed property forms
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token propertyFormModelName string ✓ ~ 128 chars Property form model name propertyId string ✓ ~ 1024 chars Property Id keyId string ✓ “grn:gs2:{region}:{ownerId}:key:default:key:default” ~ 1024 chars encryption key GRN
Result Type Description item PropertyForm Property Form body string Value to be signed signature string Signature propertyFormModel PropertyFormModel Property Form Model
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetPropertyFormWithSignature (
& formation . GetPropertyFormWithSignatureRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
body := result . Body
signature := result . Signature
propertyFormModel := result . PropertyFormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetPropertyFormWithSignatureRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getPropertyFormWithSignature (
( new GetPropertyFormWithSignatureRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$body = $result -> getBody ();
$signature = $result -> getSignature ();
$propertyFormModel = $result -> getPropertyFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetPropertyFormWithSignatureRequest ;
import io.gs2.formation.result.GetPropertyFormWithSignatureResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetPropertyFormWithSignatureResult result = client . getPropertyFormWithSignature (
new GetPropertyFormWithSignatureRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withKeyId ( "key-0001" )
);
PropertyForm item = result . getItem ();
String body = result . getBody ();
String signature = result . getSignature ();
PropertyFormModel propertyFormModel = result . getPropertyFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetPropertyFormWithSignatureRequest ;
using Gs2.Gs2Formation.Result.GetPropertyFormWithSignatureResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetPropertyFormWithSignatureResult > asyncResult = null ;
yield return client . GetPropertyFormWithSignature (
new Gs2 . Gs2Formation . Request . GetPropertyFormWithSignatureRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" )
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var body = result . Body ;
var signature = result . Signature ;
var propertyFormModel = result . PropertyFormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getPropertyFormWithSignature (
new Gs2Formation . GetPropertyFormWithSignatureRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const body = result . getBody ();
const signature = result . getSignature ();
const propertyFormModel = result . getPropertyFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_property_form_with_signature (
formation . GetPropertyFormWithSignatureRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
. with_key_id ( 'key-0001' )
)
item = result . item
body = result . body
signature = result . signature
property_form_model = result . property_form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_property_form_with_signature ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
body = result.body ;
signature = result.signature ;
propertyFormModel = result.propertyFormModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_property_form_with_signature_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
body = result.body ;
signature = result.signature ;
propertyFormModel = result.propertyFormModel ; Retrieve signed property form with user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id propertyFormModelName string ✓ ~ 128 chars Property form model name propertyId string ✓ ~ 1024 chars Property Id keyId string ✓ “grn:gs2:{region}:{ownerId}:key:default:key:default” ~ 1024 chars encryption key GRN timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description item PropertyForm Property Form body string Value to be signed signature string Signature propertyFormModel PropertyFormModel Property Form Model
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . GetPropertyFormWithSignatureByUserId (
& formation . GetPropertyFormWithSignatureByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
KeyId : pointy . String ( "key-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
body := result . Body
signature := result . Signature
propertyFormModel := result . PropertyFormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\GetPropertyFormWithSignatureByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getPropertyFormWithSignatureByUserId (
( new GetPropertyFormWithSignatureByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
-> withKeyId ( "key-0001" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$body = $result -> getBody ();
$signature = $result -> getSignature ();
$propertyFormModel = $result -> getPropertyFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.GetPropertyFormWithSignatureByUserIdRequest ;
import io.gs2.formation.result.GetPropertyFormWithSignatureByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
GetPropertyFormWithSignatureByUserIdResult result = client . getPropertyFormWithSignatureByUserId (
new GetPropertyFormWithSignatureByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withKeyId ( "key-0001" )
. withTimeOffsetToken ( null )
);
PropertyForm item = result . getItem ();
String body = result . getBody ();
String signature = result . getSignature ();
PropertyFormModel propertyFormModel = result . getPropertyFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.GetPropertyFormWithSignatureByUserIdRequest ;
using Gs2.Gs2Formation.Result.GetPropertyFormWithSignatureByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . GetPropertyFormWithSignatureByUserIdResult > asyncResult = null ;
yield return client . GetPropertyFormWithSignatureByUserId (
new Gs2 . Gs2Formation . Request . GetPropertyFormWithSignatureByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" )
. WithKeyId ( "key-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var body = result . Body ;
var signature = result . Signature ;
var propertyFormModel = result . PropertyFormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . getPropertyFormWithSignatureByUserId (
new Gs2Formation . GetPropertyFormWithSignatureByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withKeyId ( "key-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const body = result . getBody ();
const signature = result . getSignature ();
const propertyFormModel = result . getPropertyFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . get_property_form_with_signature_by_user_id (
formation . GetPropertyFormWithSignatureByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
. with_key_id ( 'key-0001' )
. with_time_offset_token ( None )
)
item = result . item
body = result . body
signature = result . signature
property_form_model = result . property_form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.get_property_form_with_signature_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
keyId = "key-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
body = result.body ;
signature = result.signature ;
propertyFormModel = result.propertyFormModel ; client = gs2 ( 'formation' )
api_result_handler = client.get_property_form_with_signature_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
keyId = "key-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
body = result.body ;
signature = result.signature ;
propertyFormModel = result.propertyFormModel ; Update property form
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token propertyFormModelName string ✓ ~ 128 chars Property form model name propertyId string ✓ ~ 1024 chars Property Id slots List<Slot> ✓ 1 ~ 10 items List of Slots
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SetPropertyForm (
& formation . SetPropertyFormRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
Slots : [] formation . Slot {
formation . Slot {
Name : pointy . String ( "slot-0001" ),
PropertyId : pointy . String ( "property-0001" ),
},
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
propertyFormModel := result . PropertyFormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SetPropertyFormRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> setPropertyForm (
( new SetPropertyFormRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
-> withSlots ([
( new Slot ())
-> withName ( "slot-0001" )
-> withPropertyId ( "property-0001" ),
])
);
$item = $result -> getItem ();
$propertyFormModel = $result -> getPropertyFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SetPropertyFormRequest ;
import io.gs2.formation.result.SetPropertyFormResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SetPropertyFormResult result = client . setPropertyForm (
new SetPropertyFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withSlots ( Arrays . asList (
new Slot ()
. withName ( "slot-0001" )
. withPropertyId ( "property-0001" )
))
);
PropertyForm item = result . getItem ();
PropertyFormModel propertyFormModel = result . getPropertyFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SetPropertyFormRequest ;
using Gs2.Gs2Formation.Result.SetPropertyFormResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SetPropertyFormResult > asyncResult = null ;
yield return client . SetPropertyForm (
new Gs2 . Gs2Formation . Request . SetPropertyFormRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" )
. WithSlots ( new Gs2 . Gs2Formation . Model . Slot [] {
new Gs2 . Gs2Formation . Model . Slot ()
. WithName ( "slot-0001" )
. WithPropertyId ( "property-0001" ),
}),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var propertyFormModel = result . PropertyFormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . setPropertyForm (
new Gs2Formation . SetPropertyFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withSlots ([
new Gs2Formation . model . Slot ()
. withName ( "slot-0001" )
. withPropertyId ( "property-0001" ),
])
);
const item = result . getItem ();
const propertyFormModel = result . getPropertyFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . set_property_form (
formation . SetPropertyFormRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
. with_slots ([
formation . Slot ()
. with_name ( 'slot-0001' )
. with_property_id ( 'property-0001' ),
])
)
item = result . item
property_form_model = result . property_form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.set_property_form ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
slots = {
{
name = "slot-0001" ,
property_id = "property-0001" ,
}
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; client = gs2 ( 'formation' )
api_result_handler = client.set_property_form_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
slots = {
{
name = "slot-0001" ,
property_id = "property-0001" ,
}
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; Update property form with user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id propertyFormModelName string ✓ ~ 128 chars Property form model name propertyId string ✓ ~ 1024 chars Property Id slots List<Slot> ✓ 1 ~ 10 items List of Slots timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SetPropertyFormByUserId (
& formation . SetPropertyFormByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
Slots : [] formation . Slot {
formation . Slot {
Name : pointy . String ( "slot-0001" ),
PropertyId : pointy . String ( "grn:1001" ),
},
},
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
propertyFormModel := result . PropertyFormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SetPropertyFormByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> setPropertyFormByUserId (
( new SetPropertyFormByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
-> withSlots ([
( new \Gs2\Formation\Model\Slot ())
-> withName ( "slot-0001" )
-> withPropertyId ( "grn:1001" ),
])
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$propertyFormModel = $result -> getPropertyFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SetPropertyFormByUserIdRequest ;
import io.gs2.formation.result.SetPropertyFormByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SetPropertyFormByUserIdResult result = client . setPropertyFormByUserId (
new SetPropertyFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withSlots ( Arrays . asList (
new io . gs2 . formation . model . Slot ()
. withName ( "slot-0001" )
. withPropertyId ( "grn:1001" )
))
. withTimeOffsetToken ( null )
);
PropertyForm item = result . getItem ();
PropertyFormModel propertyFormModel = result . getPropertyFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SetPropertyFormByUserIdRequest ;
using Gs2.Gs2Formation.Result.SetPropertyFormByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SetPropertyFormByUserIdResult > asyncResult = null ;
yield return client . SetPropertyFormByUserId (
new Gs2 . Gs2Formation . Request . SetPropertyFormByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" )
. WithSlots ( new Gs2 . Gs2Formation . Model . Slot [] {
new Gs2 . Gs2Formation . Model . Slot ()
. WithName ( "slot-0001" )
. WithPropertyId ( "grn:1001" ),
})
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var propertyFormModel = result . PropertyFormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . setPropertyFormByUserId (
new Gs2Formation . SetPropertyFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withSlots ([
new Gs2Formation . model . Slot ()
. withName ( "slot-0001" )
. withPropertyId ( "grn:1001" ),
])
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const propertyFormModel = result . getPropertyFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . set_property_form_by_user_id (
formation . SetPropertyFormByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
. with_slots ([
formation . Slot ()
. with_name ( 'slot-0001' )
. with_property_id ( 'grn:1001' ),
])
. with_time_offset_token ( None )
)
item = result . item
property_form_model = result . property_form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.set_property_form_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
slots = {
{
name = "slot-0001" ,
propertyId = "grn:1001" ,
}
},
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; client = gs2 ( 'formation' )
api_result_handler = client.set_property_form_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
slots = {
{
name = "slot-0001" ,
propertyId = "grn:1001" ,
}
},
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; Update property forms with signed slots
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token propertyFormModelName string ✓ ~ 128 chars Property form model name propertyId string ✓ ~ 1024 chars Property Id slots List<SlotWithSignature> ✓ 1 ~ 10 items List of Slot keyId string ✓ “grn:gs2:{region}:{ownerId}:key:default:key:default” ~ 1024 chars encryption key GRN
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . SetPropertyFormWithSignature (
& formation . SetPropertyFormWithSignatureRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
Slots : [] formation . SlotWithSignature {
formation . SlotWithSignature {
Name : pointy . String ( "slot-0001" ),
PropertyType : pointy . String ( "gs2_dictionary" ),
Body : pointy . String ( "body" ),
Signature : pointy . String ( "signature" ),
},
},
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
proeprtyFormModel := result . ProeprtyFormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\SetPropertyFormWithSignatureRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> setPropertyFormWithSignature (
( new SetPropertyFormWithSignatureRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
-> withSlots ([
( new SlotWithSignature ())
-> withName ( "slot-0001" )
-> withPropertyType ( "gs2_dictionary" )
-> withBody ( "body" )
-> withSignature ( "signature" ),
])
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$proeprtyFormModel = $result -> getProeprtyFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.SetPropertyFormWithSignatureRequest ;
import io.gs2.formation.result.SetPropertyFormWithSignatureResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
SetPropertyFormWithSignatureResult result = client . setPropertyFormWithSignature (
new SetPropertyFormWithSignatureRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withSlots ( Arrays . asList (
new SlotWithSignature ()
. withName ( "slot-0001" )
. withPropertyType ( "gs2_dictionary" )
. withBody ( "body" )
. withSignature ( "signature" )
))
. withKeyId ( "key-0001" )
);
PropertyForm item = result . getItem ();
PropertyFormModel proeprtyFormModel = result . getProeprtyFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.SetPropertyFormWithSignatureRequest ;
using Gs2.Gs2Formation.Result.SetPropertyFormWithSignatureResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . SetPropertyFormWithSignatureResult > asyncResult = null ;
yield return client . SetPropertyFormWithSignature (
new Gs2 . Gs2Formation . Request . SetPropertyFormWithSignatureRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" )
. WithSlots ( new Gs2 . Gs2Formation . Model . SlotWithSignature [] {
new Gs2 . Gs2Formation . Model . SlotWithSignature ()
. WithName ( "slot-0001" )
. WithPropertyType ( "gs2_dictionary" )
. WithBody ( "body" )
. WithSignature ( "signature" ),
})
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var proeprtyFormModel = result . ProeprtyFormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . setPropertyFormWithSignature (
new Gs2Formation . SetPropertyFormWithSignatureRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withSlots ([
new Gs2Formation . model . SlotWithSignature ()
. withName ( "slot-0001" )
. withPropertyType ( "gs2_dictionary" )
. withBody ( "body" )
. withSignature ( "signature" ),
])
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const proeprtyFormModel = result . getProeprtyFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . set_property_form_with_signature (
formation . SetPropertyFormWithSignatureRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
. with_slots ([
formation . SlotWithSignature ()
. with_name ( 'slot-0001' )
. with_property_type ( 'gs2_dictionary' )
. with_body ( 'body' )
. with_signature ( 'signature' ),
])
. with_key_id ( 'key-0001' )
)
item = result . item
proeprty_form_model = result . proeprty_form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.set_property_form_with_signature ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
slots = {
{
name = "slot-0001" ,
property_type = "gs2_dictionary" ,
body = "body" ,
signature = "signature" ,
}
},
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
proeprtyFormModel = result.proeprtyFormModel ; client = gs2 ( 'formation' )
api_result_handler = client.set_property_form_with_signature_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
slots = {
{
name = "slot-0001" ,
property_type = "gs2_dictionary" ,
body = "body" ,
signature = "signature" ,
}
},
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
proeprtyFormModel = result.proeprtyFormModel ; Apply get action to form properties as acquisition action
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id propertyFormModelName string ✓ ~ 128 chars Property form model name propertyId string ✓ ~ 1024 chars Property Id acquireAction AcquireAction ✓ Get action to be applied to form properties config List<Config> [] ~ 1000 items List of Acquisition config timeOffsetToken string ~ 1024 chars Time offset token
Result Type Description item PropertyForm Property Form transactionId string Issed transaction ID stampSheet string Stamp sheet stampSheetEncryptionKeyId string Cryptographic key GRN used for stamp sheet signature calculations autoRunStampSheet bool? Is transaction auto-execution enabled? atomicCommit bool? Transaction to commit atomically transaction string Issued transaction transactionResult TransactionResult Transaction execution result
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . AcquireActionsToPropertyFormProperties (
& formation . AcquireActionsToPropertyFormPropertiesRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
AcquireAction : & formation . AcquireAction {
Action : pointy . String ( "Gs2Experience:AddExperienceByUserId" ),
Request : pointy . String ( "{}" ),
},
Config : nil ,
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
transactionId := result . TransactionId
stampSheet := result . StampSheet
stampSheetEncryptionKeyId := result . StampSheetEncryptionKeyId
autoRunStampSheet := result . AutoRunStampSheet
atomicCommit := result . AtomicCommit
transaction := result . Transaction
transactionResult := result . TransactionResult use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\AcquireActionsToPropertyFormPropertiesRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> acquireActionsToPropertyFormProperties (
( new AcquireActionsToPropertyFormPropertiesRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
-> withAcquireAction (( new AcquireAction ())
-> withAction ( "Gs2Experience:AddExperienceByUserId" )
-> withRequest ( "{}" )
)
-> withConfig ( null )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$transactionId = $result -> getTransactionId ();
$stampSheet = $result -> getStampSheet ();
$stampSheetEncryptionKeyId = $result -> getStampSheetEncryptionKeyId ();
$autoRunStampSheet = $result -> getAutoRunStampSheet ();
$atomicCommit = $result -> getAtomicCommit ();
$transaction = $result -> getTransaction ();
$transactionResult = $result -> getTransactionResult ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.AcquireActionsToPropertyFormPropertiesRequest ;
import io.gs2.formation.result.AcquireActionsToPropertyFormPropertiesResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
AcquireActionsToPropertyFormPropertiesResult result = client . acquireActionsToPropertyFormProperties (
new AcquireActionsToPropertyFormPropertiesRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withAcquireAction ( new AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "{}" )
)
. withConfig ( null )
. withTimeOffsetToken ( null )
);
PropertyForm item = result . getItem ();
String transactionId = result . getTransactionId ();
String stampSheet = result . getStampSheet ();
String stampSheetEncryptionKeyId = result . getStampSheetEncryptionKeyId ();
boolean autoRunStampSheet = result . getAutoRunStampSheet ();
boolean atomicCommit = result . getAtomicCommit ();
String transaction = result . getTransaction ();
TransactionResult transactionResult = result . getTransactionResult ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.AcquireActionsToPropertyFormPropertiesRequest ;
using Gs2.Gs2Formation.Result.AcquireActionsToPropertyFormPropertiesResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . AcquireActionsToPropertyFormPropertiesResult > asyncResult = null ;
yield return client . AcquireActionsToPropertyFormProperties (
new Gs2 . Gs2Formation . Request . AcquireActionsToPropertyFormPropertiesRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" )
. WithAcquireAction ( new Gs2 . Core . Model . AcquireAction ()
. WithAction ( "Gs2Experience:AddExperienceByUserId" )
. WithRequest ( "{}" )
)
. WithConfig ( null )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var transactionId = result . TransactionId ;
var stampSheet = result . StampSheet ;
var stampSheetEncryptionKeyId = result . StampSheetEncryptionKeyId ;
var autoRunStampSheet = result . AutoRunStampSheet ;
var atomicCommit = result . AtomicCommit ;
var transaction = result . Transaction ;
var transactionResult = result . TransactionResult ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . acquireActionsToPropertyFormProperties (
new Gs2Formation . AcquireActionsToPropertyFormPropertiesRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withAcquireAction ( new Gs2Formation . model . AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "{}" )
)
. withConfig ( null )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const transactionId = result . getTransactionId ();
const stampSheet = result . getStampSheet ();
const stampSheetEncryptionKeyId = result . getStampSheetEncryptionKeyId ();
const autoRunStampSheet = result . getAutoRunStampSheet ();
const atomicCommit = result . getAtomicCommit ();
const transaction = result . getTransaction ();
const transactionResult = result . getTransactionResult ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . acquire_actions_to_property_form_properties (
formation . AcquireActionsToPropertyFormPropertiesRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
. with_acquire_action ( formation . AcquireAction ()
. with_action ( 'Gs2Experience:AddExperienceByUserId' )
. with_request ( ' {} ' )
)
. with_config ( None )
. with_time_offset_token ( None )
)
item = result . item
transaction_id = result . transaction_id
stamp_sheet = result . stamp_sheet
stamp_sheet_encryption_key_id = result . stamp_sheet_encryption_key_id
auto_run_stamp_sheet = result . auto_run_stamp_sheet
atomic_commit = result . atomic_commit
transaction = result . transaction
transaction_result = result . transaction_result
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.acquire_actions_to_property_form_properties ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
acquireAction = {
action = "Gs2Experience:AddExperienceByUserId" ,
request = "{}" ,
},
config = nil ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
transactionId = result.transactionId ;
stampSheet = result.stampSheet ;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId ;
autoRunStampSheet = result.autoRunStampSheet ;
atomicCommit = result.atomicCommit ;
transaction = result.transaction ;
transactionResult = result.transactionResult ; client = gs2 ( 'formation' )
api_result_handler = client.acquire_actions_to_property_form_properties_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
acquireAction = {
action = "Gs2Experience:AddExperienceByUserId" ,
request = "{}" ,
},
config = nil ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
transactionId = result.transactionId ;
stampSheet = result.stampSheet ;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId ;
autoRunStampSheet = result.autoRunStampSheet ;
atomicCommit = result.atomicCommit ;
transaction = result.transaction ;
transactionResult = result.transactionResult ; Delete property form model name
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name accessToken string ✓ ~ 128 chars Access token propertyFormModelName string ✓ ~ 128 chars Property form model name propertyId string ✓ ~ 1024 chars Property Id
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeletePropertyForm (
& formation . DeletePropertyFormRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
propertyFormModel := result . PropertyFormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeletePropertyFormRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deletePropertyForm (
( new DeletePropertyFormRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withAccessToken ( "accessToken-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
);
$item = $result -> getItem ();
$propertyFormModel = $result -> getPropertyFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeletePropertyFormRequest ;
import io.gs2.formation.result.DeletePropertyFormResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeletePropertyFormResult result = client . deletePropertyForm (
new DeletePropertyFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
);
PropertyForm item = result . getItem ();
PropertyFormModel propertyFormModel = result . getPropertyFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeletePropertyFormRequest ;
using Gs2.Gs2Formation.Result.DeletePropertyFormResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeletePropertyFormResult > asyncResult = null ;
yield return client . DeletePropertyForm (
new Gs2 . Gs2Formation . Request . DeletePropertyFormRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var propertyFormModel = result . PropertyFormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deletePropertyForm (
new Gs2Formation . DeletePropertyFormRequest ()
. withNamespaceName ( "namespace-0001" )
. withAccessToken ( "accessToken-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
);
const item = result . getItem ();
const propertyFormModel = result . getPropertyFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_property_form (
formation . DeletePropertyFormRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_access_token ( 'accessToken-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
)
item = result . item
property_form_model = result . property_form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_property_form ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; client = gs2 ( 'formation' )
api_result_handler = client.delete_property_form_async ({
namespaceName = "namespace-0001" ,
accessToken = "accessToken-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; Delete property form model name with user ID
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User Id propertyFormModelName string ✓ ~ 128 chars Property form model name propertyId string ✓ ~ 1024 chars Property Id timeOffsetToken string ~ 1024 chars Time offset token
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . DeletePropertyFormByUserId (
& formation . DeletePropertyFormByUserIdRequest {
NamespaceName : pointy . String ( "namespace-0001" ),
UserId : pointy . String ( "user-0001" ),
PropertyFormModelName : pointy . String ( "form-0001" ),
PropertyId : pointy . String ( "property-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
propertyFormModel := result . PropertyFormModel use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\DeletePropertyFormByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deletePropertyFormByUserId (
( new DeletePropertyFormByUserIdRequest ())
-> withNamespaceName ( "namespace-0001" )
-> withUserId ( "user-0001" )
-> withPropertyFormModelName ( "form-0001" )
-> withPropertyId ( "property-0001" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$propertyFormModel = $result -> getPropertyFormModel ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.DeletePropertyFormByUserIdRequest ;
import io.gs2.formation.result.DeletePropertyFormByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
DeletePropertyFormByUserIdResult result = client . deletePropertyFormByUserId (
new DeletePropertyFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withTimeOffsetToken ( null )
);
PropertyForm item = result . getItem ();
PropertyFormModel propertyFormModel = result . getPropertyFormModel ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.DeletePropertyFormByUserIdRequest ;
using Gs2.Gs2Formation.Result.DeletePropertyFormByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . DeletePropertyFormByUserIdResult > asyncResult = null ;
yield return client . DeletePropertyFormByUserId (
new Gs2 . Gs2Formation . Request . DeletePropertyFormByUserIdRequest ()
. WithNamespaceName ( "namespace-0001" )
. WithUserId ( "user-0001" )
. WithPropertyFormModelName ( "form-0001" )
. WithPropertyId ( "property-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var propertyFormModel = result . PropertyFormModel ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . deletePropertyFormByUserId (
new Gs2Formation . DeletePropertyFormByUserIdRequest ()
. withNamespaceName ( "namespace-0001" )
. withUserId ( "user-0001" )
. withPropertyFormModelName ( "form-0001" )
. withPropertyId ( "property-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const propertyFormModel = result . getPropertyFormModel ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . delete_property_form_by_user_id (
formation . DeletePropertyFormByUserIdRequest ()
. with_namespace_name ( 'namespace-0001' )
. with_user_id ( 'user-0001' )
. with_property_form_model_name ( 'form-0001' )
. with_property_id ( 'property-0001' )
. with_time_offset_token ( None )
)
item = result . item
property_form_model = result . property_form_model
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.delete_property_form_by_user_id ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; client = gs2 ( 'formation' )
api_result_handler = client.delete_property_form_by_user_id_async ({
namespaceName = "namespace-0001" ,
userId = "user-0001" ,
propertyFormModelName = "form-0001" ,
propertyId = "property-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
propertyFormModel = result.propertyFormModel ; Execute the application of the acquire action to the property of the property form as an acquisition action
Request Type Condition Require Default Limitation Description stampSheet string ✓ ~ 5242880 chars Transaction keyId string ✓ ~ 1024 chars encryption key GRN
Result Type Description item PropertyForm Property form transactionId string Issed transaction ID stampSheet string Stamp sheet stampSheetEncryptionKeyId string Cryptographic key GRN used for stamp sheet signature calculations autoRunStampSheet bool? Is transaction auto-execution enabled? atomicCommit bool? Transaction to commit atomically transaction string Issued transaction transactionResult TransactionResult Transaction execution result
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/formation"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := formation . Gs2FormationRestClient {
Session : & session ,
}
result , err := client . AcquireActionToPropertyFormPropertiesByStampSheet (
& formation . AcquireActionToPropertyFormPropertiesByStampSheetRequest {
StampSheet : pointy . String ( "stampSheet" ),
KeyId : pointy . String ( "key-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
transactionId := result . TransactionId
stampSheet := result . StampSheet
stampSheetEncryptionKeyId := result . StampSheetEncryptionKeyId
autoRunStampSheet := result . AutoRunStampSheet
atomicCommit := result . AtomicCommit
transaction := result . Transaction
transactionResult := result . TransactionResult use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Formation\Gs2FormationRestClient ;
use Gs2\Formation\Request\AcquireActionToPropertyFormPropertiesByStampSheetRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> acquireActionToPropertyFormPropertiesByStampSheet (
( new AcquireActionToPropertyFormPropertiesByStampSheetRequest ())
-> withStampSheet ( "stampSheet" )
-> withKeyId ( "key-0001" )
);
$item = $result -> getItem ();
$transactionId = $result -> getTransactionId ();
$stampSheet = $result -> getStampSheet ();
$stampSheetEncryptionKeyId = $result -> getStampSheetEncryptionKeyId ();
$autoRunStampSheet = $result -> getAutoRunStampSheet ();
$atomicCommit = $result -> getAtomicCommit ();
$transaction = $result -> getTransaction ();
$transactionResult = $result -> getTransactionResult ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
} import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.formation.rest.Gs2FormationRestClient ;
import io.gs2.formation.request.AcquireActionToPropertyFormPropertiesByStampSheetRequest ;
import io.gs2.formation.result.AcquireActionToPropertyFormPropertiesByStampSheetResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2FormationRestClient client = new Gs2FormationRestClient ( session );
try {
AcquireActionToPropertyFormPropertiesByStampSheetResult result = client . acquireActionToPropertyFormPropertiesByStampSheet (
new AcquireActionToPropertyFormPropertiesByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
PropertyForm item = result . getItem ();
String transactionId = result . getTransactionId ();
String stampSheet = result . getStampSheet ();
String stampSheetEncryptionKeyId = result . getStampSheetEncryptionKeyId ();
boolean autoRunStampSheet = result . getAutoRunStampSheet ();
boolean atomicCommit = result . getAtomicCommit ();
String transaction = result . getTransaction ();
TransactionResult transactionResult = result . getTransactionResult ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
} using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Formation.Gs2FormationRestClient ;
using Gs2.Gs2Formation.Request.AcquireActionToPropertyFormPropertiesByStampSheetRequest ;
using Gs2.Gs2Formation.Result.AcquireActionToPropertyFormPropertiesByStampSheetResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2FormationRestClient ( session );
AsyncResult < Gs2 . Gs2Formation . Result . AcquireActionToPropertyFormPropertiesByStampSheetResult > asyncResult = null ;
yield return client . AcquireActionToPropertyFormPropertiesByStampSheet (
new Gs2 . Gs2Formation . Request . AcquireActionToPropertyFormPropertiesByStampSheetRequest ()
. WithStampSheet ( "stampSheet" )
. WithKeyId ( "key-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var transactionId = result . TransactionId ;
var stampSheet = result . StampSheet ;
var stampSheetEncryptionKeyId = result . StampSheetEncryptionKeyId ;
var autoRunStampSheet = result . AutoRunStampSheet ;
var atomicCommit = result . AtomicCommit ;
var transaction = result . Transaction ;
var transactionResult = result . TransactionResult ; import Gs2Core from '@/gs2/core' ;
import * as Gs2Formation from '@/gs2/formation' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Formation . Gs2FormationRestClient ( session );
try {
const result = await client . acquireActionToPropertyFormPropertiesByStampSheet (
new Gs2Formation . AcquireActionToPropertyFormPropertiesByStampSheetRequest ()
. withStampSheet ( "stampSheet" )
. withKeyId ( "key-0001" )
);
const item = result . getItem ();
const transactionId = result . getTransactionId ();
const stampSheet = result . getStampSheet ();
const stampSheetEncryptionKeyId = result . getStampSheetEncryptionKeyId ();
const autoRunStampSheet = result . getAutoRunStampSheet ();
const atomicCommit = result . getAtomicCommit ();
const transaction = result . getTransaction ();
const transactionResult = result . getTransactionResult ();
} catch ( e ) {
process . exit ( 1 );
} from gs2 import core
from gs2 import formation
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = formation . Gs2FormationRestClient ( session )
try :
result = client . acquire_action_to_property_form_properties_by_stamp_sheet (
formation . AcquireActionToPropertyFormPropertiesByStampSheetRequest ()
. with_stamp_sheet ( 'stampSheet' )
. with_key_id ( 'key-0001' )
)
item = result . item
transaction_id = result . transaction_id
stamp_sheet = result . stamp_sheet
stamp_sheet_encryption_key_id = result . stamp_sheet_encryption_key_id
auto_run_stamp_sheet = result . auto_run_stamp_sheet
atomic_commit = result . atomic_commit
transaction = result . transaction
transaction_result = result . transaction_result
except core . Gs2Exception as e :
exit ( 1 ) client = gs2 ( 'formation' )
api_result = client.acquire_action_to_property_form_properties_by_stamp_sheet ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
transactionId = result.transactionId ;
stampSheet = result.stampSheet ;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId ;
autoRunStampSheet = result.autoRunStampSheet ;
atomicCommit = result.atomicCommit ;
transaction = result.transaction ;
transactionResult = result.transactionResult ; client = gs2 ( 'formation' )
api_result_handler = client.acquire_action_to_property_form_properties_by_stamp_sheet_async ({
stampSheet = "stampSheet" ,
keyId = "key-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
transactionId = result.transactionId ;
stampSheet = result.stampSheet ;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId ;
autoRunStampSheet = result.autoRunStampSheet ;
atomicCommit = result.atomicCommit ;
transaction = result.transaction ;
transactionResult = result.transactionResult ;