NAV Navbar
Python Java GS2-Formation
 

GS2-Formation

装備やパーティ編成機能を実現します。

編成情報を記録する フォーム(Form) と、編成した フォーム を保存する 保存したフォーム(Mold) があります。 パーティ編成を例にすると、キャラクターを フォーム に設定し、パーティを編成します。 編成したパーティ情報を複数記録する場合は 保存したフォーム を使って実現できます。

保存したフォーム に保存できる数にはキャパシティを設定でき、キャパシティの値は引き上げることができます。

フォーム に編成するプロパティはプロパティIDで指定することになりますが、プロパティの正規表現で値を限定することができます。 また、GS2-Inventory のリソースを設定する場合は、GS2-Inventory が発行する 署名付きアイテムセット を使って編成対象に指定できます。 署名付きアイテムセット とは、該当のアイテムを所有していることを保証する署名付きプロパティ情報で、こちらを使う場合はクライアントから直接編成することを許します。

この 所有していることを保証する とは編成時点での保証であり、編成後にプロパティを手放した場合のフォローはありません。 GS2-Inventory でプロパティを消費したり売却したりする場合は、事前に GS2-Formation で編成に使用されていないかの判定はクライアントまたはスクリプトで実装する必要があります。

GS2-Formation のデータ構造は以下です。

モデル

Namespace

ネームスペース

ネームスペースにはフォームを最大10000種類指定できます。

ネームスペースを分割することで生じるデメリットは特にありません。

パラメータ データ型 必須 説明
namespaceId string true ネームスペース
ownerId string true オーナーID
name string true ネームスペース名
description string false ネームスペースの説明
updateMoldScript ScriptSetting false キャパシティを更新するときに実行するスクリプト
updateFormScript ScriptSetting false フォームを更新するときに実行するスクリプト
logSetting LogSetting false ログの出力設定
createdAt long true 作成日時
updatedAt long true 最終更新日時

FormModel

フォームモデル

パラメータ データ型 必須 説明
formModelId string true フォームマスター
name string true フォームの種類名
metadata string false フォームの種類のメタデータ
slots list[SlotModel] true スリットリスト

FormModelMaster

フォームマスター

パラメータ データ型 必須 説明
formModelId string true フォームマスター
name string true フォーム名
description string false フォームマスターの説明
metadata string false フォームのメタデータ
slots list[SlotModel] true スロットリスト
createdAt long true 作成日時
updatedAt long true 最終更新日時

MoldModel

フォームの保存領域

パラメータ データ型 必須 説明
moldModelId string true フォームの保存領域マスター
name string true フォームの保存領域名
metadata string false メタデータ
formModel FormModel false フォームモデル
initialMaxCapacity integer true フォームを保存できる初期キャパシティ
maxCapacity integer true フォームを保存できるキャパシティ

MoldModelMaster

フォームの保存領域マスター

パラメータ データ型 必須 説明
moldModelId string true フォームの保存領域マスター
name string true フォームの保存領域名
description string false フォームの保存領域マスターの説明
metadata string false フォームの保存領域のメタデータ
formModelId string true フォームマスター
initialMaxCapacity integer true フォームを保存できる初期キャパシティ
maxCapacity integer true フォームを保存できるキャパシティ
createdAt long true 作成日時
updatedAt long true 最終更新日時

CurrentFormMaster

現在有効なフォーム設定

エクスポートしたマスターデータを、現在有効なフォーム設定としてインポートして使用します。

パラメータ データ型 必須 説明
namespaceId string true ネームスペース
settings string true マスターデータ

Mold

保存したフォーム

ゲームプレイヤーは複数のフォームパターンを保存できます。 このエンティティは保存したフォームに対して1つのエントリが作成されます。

パラメータ データ型 必須 説明
moldId string true 保存したフォーム
name string true フォームの保存領域の名前
userId string false ユーザーID
capacity integer true 現在のキャパシティ
createdAt long true 作成日時
updatedAt long true 最終更新日時

Form

フォーム

フォームとは複数のプロパティを編成したものです。 キャラクターを編成してパーティに。武器や防具を編成して装備とした場合、『パーティ』や『装備』がフォームに相当します。

パラメータ データ型 必須 説明
formId string true フォーム
name string true フォームの保存領域の名前
index integer true 保存領域のインデックス
slots list[Slot] true スロットリスト
createdAt long true 作成日時
updatedAt long true 最終更新日時

Slot

スロット

フォームに設定するプロパティ

パラメータ データ型 必須 説明
name string true スロットモデル名
propertyId string true プロパティID

ResponseCache

レスポンスキャッシュ

パラメータ データ型 必須 説明
region string false
ownerId string true オーナーID
responseCacheId string true レスポンスキャッシュ のGRN
requestHash string false
result string true APIの応答内容

SlotModel

スロットモデル

パラメータ データ型 必須 説明
name string true スロットモデル名
propertyRegex string false プロパティとして設定可能な値の正規表現
metadata string false メタデータ

SlotWithSignature

署名付きスロット

フォームに設定する存在証明されたプロパティ

パラメータ データ型 必須 説明
name string true スロットモデル名
propertyType string true プロパティの種類
body string true ペイロード
signature string true プロパティIDのリソースを所有していることを証明する署名

AcquireActionConfig

入手アクションコンフィグ

パラメータ データ型 必須 説明
name string false スロット名
config list[Config] false スタンプシートに使用するコンフィグ

Config

設定値

パラメータ データ型 必須 説明
key string false 名前
value string false

GitHubCheckoutSetting

GitHubからリソースをチェックアウトしてくる設定

パラメータ データ型 必須 説明
apiKeyId string true リソースの取得に使用するGitHub のAPIキー のGRN
repositoryName string true リポジトリ名
sourcePath string true ソースコードのファイルパス
referenceType string true コードの取得元
commitHash string true コミットハッシュ
branchName string true ブランチ名
tagName string true タグ名

ScriptSetting

スクリプト設定

パラメータ データ型 必須 説明
triggerScriptId string false 実行前に使用する GS2-Script のスクリプト のGRN
doneTriggerScriptId string false 完了時に使用する GS2-Script のスクリプト のGRN
doneTriggerQueueNamespaceId string false 完了時に使用する GS2-JobQueue のネームスペース のGRN

LogSetting

ロギング通知設定

パラメータ データ型 必須 説明
loggingNamespaceId string false ログの記録に使用する GS2-Log のネームスペース のGRN

AcquireAction

入手アクション

パラメータ データ型 必須 説明
action string true スタンプシートで実行するアクションの種類
request string true 入手リクエストのJSON

初期化処理

HTTPプロトコル クライアントの初期化 同期処理

import gs2_core_client.model.*
import gs2_formation_client.rest.*

session = Gs2RestSession(
    region=Region.AP_NORTHEAST_1,
    credential=BasicGs2Credential(
        client_id='your client id',
        client_secret='your client secret',
    ),
)
session.connect()
client = Gs2FormationRestClient(session)
import io.gs2.core.model.Region
import io.gs2.core.model.BasicGs2Credential
import io.gs2.core.rest.Gs2RestSession
import io.gs2.formation.rest.Gs2FormationRestClient

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
)
session.connect()
Gs2FormationRestClient client = new Gs2FormationRestClient(session)
初期化処理は不要です

HTTPプロトコル クライアントの初期化 非同期処理

import gs2_core_client.model.*
import gs2_formation_client.rest.*

session = Gs2RestSession(
    region=Region.AP_NORTHEAST_1,
    credential=BasicGs2Credential(
        client_id='your client id',
        client_secret='your client secret',
    ),
)

def complete(result: AsyncResult[None]):
    client = Gs2FormationRestClient(session)

session.connect_async(
    complete,
)
import io.gs2.core.model.Region
import io.gs2.core.model.BasicGs2Credential
import io.gs2.core.rest.Gs2RestSession
import io.gs2.formation.rest.Gs2FormationRestClient

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
)

session.connect_async(
    (result) => {
        Gs2FormationRestClient client = new Gs2FormationRestClient(session)
    }
)
初期化処理は不要です

WebSocketプロトコル クライアントの初期化 同期処理

import gs2_core_client.model.*
import gs2_formation_client.web_socket.*

session = Gs2WebSocketSession(
    region=Region.AP_NORTHEAST_1,
    credential=BasicGs2Credential(
        client_id='your client id',
        client_secret='your client secret',
    ),
)
session.connect()
client = Gs2FormationWebSocketClient(session)
import io.gs2.core.model.Region
import io.gs2.core.model.BasicGs2Credential
import io.gs2.core.webSocket.Gs2WebSocketSession
import io.gs2.formation.webSocket.Gs2FormationWebSocketClient

Gs2WebSocketSession session = new Gs2WebSocketSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
)

session.connect()
Gs2FormationWebSocketClient client = new Gs2FormationWebSocketClient(session)
初期化処理は不要です

WebSocketプロトコル クライアントの初期化 非同期処理

import gs2_core_client.model.*
import gs2_formation_client.web_socket.*

session = Gs2WebSocketSession(
    region=Region.AP_NORTHEAST_1,
    credential=BasicGs2Credential(
        client_id='your client id',
        client_secret='your client secret',
    ),
)

def complete(result: AsyncResult[None]):
    client = Gs2FormationWebSocketClient(session)

session.connect_async(
    complete,
)
import io.gs2.core.model.Region
import io.gs2.core.model.BasicGs2Credential
import io.gs2.core.webSocket.Gs2WebSocketSession
import io.gs2.formation.webSocket.Gs2FormationWebSocketClient

Gs2WebSocketSession session = new Gs2WebSocketSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
)

session.connect_async(
    (result) => {
        Gs2FormationWebSocketClient client = new Gs2FormationWebSocketClient(session)
    }
)
初期化処理は不要です

GS2-Formation は HTTPプロトコル と WebSocketプロトコル の2種類のプロトコルをサポートしています。

HTTPプロトコル と WebSocketプロトコル の違いは以下に示すとおりです。

HTTP WebSocket
接続方式 都度接続 常時接続
応答性能 優れている
API制限 なし 大容量のデータをやりとりするAPIには使用不可(主にマスターデータ系処理)
利用料金 WebSocketと同一 HTTPと同一

終了処理

HTTPプロトコル クライアントの終了処理

session.disconnect()
session.disconnect();
終了処理は不要です

WebSocketプロトコル クライアントの終了処理

session.disconnect()
session.disconnect();
終了処理は不要です

session オブジェクトの切断処理を行って終了処理を行います。 同一 session オブジェクトを複数の異なる Client オブジェクトに渡すことができます。

メソッド

acquireActionToFormPropertiesByStampSheet

同期処理

from gs2_formation_client.request import AcquireActionToFormPropertiesByStampSheetRequest
from gs2_formation_client.result import AcquireActionToFormPropertiesByStampSheetResult

result = client.acquire_action_to_form_properties_by_stamp_sheet(
    AcquireActionToFormPropertiesByStampSheetRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.AcquireActionToFormPropertiesByStampSheetRequest
import io.gs2.formation.result.AcquireActionToFormPropertiesByStampSheetResult

result = client.acquireActionToFormPropertiesByStampSheet(
    AcquireActionToFormPropertiesByStampSheetRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import AcquireActionToFormPropertiesByStampSheetRequest
from gs2_formation_client.result import AcquireActionToFormPropertiesByStampSheetResult

def callback(async_result: AsyncResult[AcquireActionToFormPropertiesByStampSheetResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.acquire_action_to_form_properties_by_stamp_sheet_async(
    AcquireActionToFormPropertiesByStampSheetRequest()\
    callback
)
import io.gs2.formation.request.AcquireActionToFormPropertiesByStampSheetRequest
import io.gs2.formation.result.AcquireActionToFormPropertiesByStampSheetResult

result = client.acquireActionToFormPropertiesByStampSheet(
    AcquireActionToFormPropertiesByStampSheetRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

スタンプシートでアイテムをインベントリに追加

パラメータ データ型 必須 説明
stampSheet string true スタンプシート
keyId string true スタンプシートの署名検証に使用する 暗号鍵 のGRN
パラメータ データ型 説明
item Form フォーム
mold Mold 保存したフォーム
stampSheet string スタンプシート

acquireActionsToFormProperties

同期処理

from gs2_formation_client.request import AcquireActionsToFormPropertiesRequest
from gs2_formation_client.result import AcquireActionsToFormPropertiesResult

result = client.acquire_actions_to_form_properties(
    AcquireActionsToFormPropertiesRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.AcquireActionsToFormPropertiesRequest
import io.gs2.formation.result.AcquireActionsToFormPropertiesResult

result = client.acquireActionsToFormProperties(
    AcquireActionsToFormPropertiesRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import AcquireActionsToFormPropertiesRequest
from gs2_formation_client.result import AcquireActionsToFormPropertiesResult

def callback(async_result: AsyncResult[AcquireActionsToFormPropertiesResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.acquire_actions_to_form_properties_async(
    AcquireActionsToFormPropertiesRequest()\
    callback
)
import io.gs2.formation.request.AcquireActionsToFormPropertiesRequest
import io.gs2.formation.result.AcquireActionsToFormPropertiesResult

result = client.acquireActionsToFormProperties(
    AcquireActionsToFormPropertiesRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

署名付きスロットを使ってフォームを更新

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
userId string false ユーザーID
moldName string true フォームの保存領域の名前
index integer true 保存領域のインデックス
acquireAction AcquireAction true フォームのプロパティに適用する入手アクション
queueNamespaceId string true 入手処理を登録する GS2-JobQueue のネームスペース のGRN
keyId string true スタンプシートの発行に使用する GS2-Key の暗号鍵 のGRN
config list[AcquireActionConfig] false 入手アクションに適用するコンフィグ
パラメータ データ型 説明
item Form フォーム
mold Mold 保存したフォーム
stampSheet string スタンプシート

addCapacityByStampSheet

同期処理

from gs2_formation_client.request import AddCapacityByStampSheetRequest
from gs2_formation_client.result import AddCapacityByStampSheetResult

result = client.add_capacity_by_stamp_sheet(
    AddCapacityByStampSheetRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.AddCapacityByStampSheetRequest
import io.gs2.formation.result.AddCapacityByStampSheetResult

result = client.addCapacityByStampSheet(
    AddCapacityByStampSheetRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import AddCapacityByStampSheetRequest
from gs2_formation_client.result import AddCapacityByStampSheetResult

def callback(async_result: AsyncResult[AddCapacityByStampSheetResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.add_capacity_by_stamp_sheet_async(
    AddCapacityByStampSheetRequest()\
    callback
)
import io.gs2.formation.request.AddCapacityByStampSheetRequest
import io.gs2.formation.result.AddCapacityByStampSheetResult

result = client.addCapacityByStampSheet(
    AddCapacityByStampSheetRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

スタンプシートでキャパシティサイズを加算

パラメータ データ型 必須 説明
stampSheet string true スタンプシート
keyId string true スタンプシートの署名検証に使用する 暗号鍵 のGRN
パラメータ データ型 説明
item Mold キャパシティ加算後の保存したフォーム
moldModel MoldModel フォームの保存領域

addMoldCapacityByUserId

同期処理

from gs2_formation_client.request import AddMoldCapacityByUserIdRequest
from gs2_formation_client.result import AddMoldCapacityByUserIdResult

result = client.add_mold_capacity_by_user_id(
    AddMoldCapacityByUserIdRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.AddMoldCapacityByUserIdRequest
import io.gs2.formation.result.AddMoldCapacityByUserIdResult

result = client.addMoldCapacityByUserId(
    AddMoldCapacityByUserIdRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import AddMoldCapacityByUserIdRequest
from gs2_formation_client.result import AddMoldCapacityByUserIdResult

def callback(async_result: AsyncResult[AddMoldCapacityByUserIdResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.add_mold_capacity_by_user_id_async(
    AddMoldCapacityByUserIdRequest()\
    callback
)
import io.gs2.formation.request.AddMoldCapacityByUserIdRequest
import io.gs2.formation.result.AddMoldCapacityByUserIdResult

result = client.addMoldCapacityByUserId(
    AddMoldCapacityByUserIdRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ユーザIDを指定して保存したフォームのキャパシティを追加

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
userId string false ユーザーID
moldName string true フォームの保存領域の名前
capacity integer true 加算するキャパシティ量
パラメータ データ型 説明
item Mold キャパシティを更新した保存したフォーム
moldModel MoldModel フォームの保存領域

createFormModelMaster

同期処理

from gs2_formation_client.request import CreateFormModelMasterRequest
from gs2_formation_client.result import CreateFormModelMasterResult

result = client.create_form_model_master(
    CreateFormModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_name('form-0001')\
        .with_slots([
Object("SlotModel", {"name": 'slot-0001', "propertyRegex": '.*'}),  
Object("SlotModel", {"name": 'slot-0002', "propertyRegex": '.*', "metadata": 'METADATA_0002'})
])
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.CreateFormModelMasterRequest
import io.gs2.formation.result.CreateFormModelMasterResult

result = client.createFormModelMaster(
    CreateFormModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withName("form-0001")
        .withSlots(new [] {
Object("SlotModel", {"name": "slot-0001", "propertyRegex": ".*"}),  
Object("SlotModel", {"name": "slot-0002", "propertyRegex": ".*", "metadata": "METADATA_0002"})
})
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import CreateFormModelMasterRequest
from gs2_formation_client.result import CreateFormModelMasterResult

def callback(async_result: AsyncResult[CreateFormModelMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.create_form_model_master_async(
    CreateFormModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_name('form-0001')\
        .with_slots([
Object("SlotModel", {"name": 'slot-0001', "propertyRegex": '.*'}),  
Object("SlotModel", {"name": 'slot-0002', "propertyRegex": '.*', "metadata": 'METADATA_0002'})
]),
    callback
)
import io.gs2.formation.request.CreateFormModelMasterRequest
import io.gs2.formation.result.CreateFormModelMasterResult

result = client.createFormModelMaster(
    CreateFormModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withName("form-0001")
        .withSlots(new [] {
Object("SlotModel", {"name": "slot-0001", "propertyRegex": ".*"}),  
Object("SlotModel", {"name": "slot-0002", "propertyRegex": ".*", "metadata": "METADATA_0002"})
}),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)
Type: GS2::Formation::FormModelMaster
Properties:
  NamespaceName: String
  Name: String
  Description: Optional[String]
  Metadata: Optional[String]
  Slots:
    -
      Name: String
      PropertyRegex: Optional[String]
      Metadata: Optional[String]
    -
      Name: String
      PropertyRegex: Optional[String]
      Metadata: Optional[String]

フォームマスターを新規作成

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
name string true フォーム名
description string false フォームマスターの説明
metadata string false フォームのメタデータ
slots list[SlotModel] true スロットリスト
パラメータ データ型 説明
item FormModelMaster 作成したフォームマスター

createMoldModelMaster

同期処理

from gs2_formation_client.request import CreateMoldModelMasterRequest
from gs2_formation_client.result import CreateMoldModelMasterResult

result = client.create_mold_model_master(
    CreateMoldModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_name('mold-0001')\
        .with_form_model_id(form_model1['formModelId'])\
        .with_initial_max_capacity(5)\
        .with_max_capacity(10)
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.CreateMoldModelMasterRequest
import io.gs2.formation.result.CreateMoldModelMasterResult

result = client.createMoldModelMaster(
    CreateMoldModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withName("mold-0001")
        .withFormModelId(form_model1.get'FormModelId())
        .withInitialMaxCapacity(5)
        .withMaxCapacity(10)
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import CreateMoldModelMasterRequest
from gs2_formation_client.result import CreateMoldModelMasterResult

def callback(async_result: AsyncResult[CreateMoldModelMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.create_mold_model_master_async(
    CreateMoldModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_name('mold-0001')\
        .with_form_model_id(form_model1['formModelId'])\
        .with_initial_max_capacity(5)\
        .with_max_capacity(10),
    callback
)
import io.gs2.formation.request.CreateMoldModelMasterRequest
import io.gs2.formation.result.CreateMoldModelMasterResult

result = client.createMoldModelMaster(
    CreateMoldModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withName("mold-0001")
        .withFormModelId(form_model1.get'FormModelId())
        .withInitialMaxCapacity(5)
        .withMaxCapacity(10),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)
Type: GS2::Formation::MoldModelMaster
Properties:
  NamespaceName: String
  Name: String
  Description: Optional[String]
  Metadata: Optional[String]
  FormModelId: String
  InitialMaxCapacity: Integer
  MaxCapacity: Integer

フォームの保存領域マスターを新規作成

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
name string true フォームの保存領域名
description string false フォームの保存領域マスターの説明
metadata string false フォームの保存領域のメタデータ
formModelId string true フォームマスター
initialMaxCapacity integer true フォームを保存できる初期キャパシティ
maxCapacity integer true フォームを保存できるキャパシティ
パラメータ データ型 説明
item MoldModelMaster 作成したフォームの保存領域マスター

createNamespace

同期処理

from gs2_formation_client.request import CreateNamespaceRequest
from gs2_formation_client.result import CreateNamespaceResult

result = client.create_namespace(
    CreateNamespaceRequest()\
        .with_name('namespace-0001')\
        .with_log_setting(Object("LogSetting", {"loggingNamespaceId": 'grn:gs2:ap-northeast-1:{ownerId}:log:namespace-0001'}))
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.CreateNamespaceRequest
import io.gs2.formation.result.CreateNamespaceResult

result = client.createNamespace(
    CreateNamespaceRequest()
        .withName("namespace-0001")
        .withLogSetting(Object("LogSetting", {"loggingNamespaceId": "grn:gs2:ap-northeast-1:{ownerId}:log:namespace-0001"}))
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import CreateNamespaceRequest
from gs2_formation_client.result import CreateNamespaceResult

def callback(async_result: AsyncResult[CreateNamespaceResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.create_namespace_async(
    CreateNamespaceRequest()\
        .with_name('namespace-0001')\
        .with_log_setting(Object("LogSetting", {"loggingNamespaceId": 'grn:gs2:ap-northeast-1:{ownerId}:log:namespace-0001'})),
    callback
)
import io.gs2.formation.request.CreateNamespaceRequest
import io.gs2.formation.result.CreateNamespaceResult

result = client.createNamespace(
    CreateNamespaceRequest()
        .withName("namespace-0001")
        .withLogSetting(Object("LogSetting", {"loggingNamespaceId": "grn:gs2:ap-northeast-1:{ownerId}:log:namespace-0001"})),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)
Type: GS2::Formation::Namespace
Properties:
  Name: String
  Description: Optional[String]
  UpdateMoldScript:
    TriggerScriptId: Optional[String]
    DoneTriggerScriptId: Optional[String]
    DoneTriggerQueueNamespaceId: Optional[String]
  UpdateFormScript:
    TriggerScriptId: Optional[String]
    DoneTriggerScriptId: Optional[String]
    DoneTriggerQueueNamespaceId: Optional[String]
  LogSetting:
    LoggingNamespaceId: Optional[String]

ネームスペースを新規作成

パラメータ データ型 必須 説明
name string true ネームスペース名
description string false ネームスペースの説明
updateMoldScript ScriptSetting false キャパシティを更新するときに実行するスクリプト
updateFormScript ScriptSetting false フォームを更新するときに実行するスクリプト
logSetting LogSetting false ログの出力設定
パラメータ データ型 説明
item Namespace 作成したネームスペース

deleteForm

同期処理

from gs2_formation_client.request import DeleteFormRequest
from gs2_formation_client.result import DeleteFormResult

result = client.delete_form(
    DeleteFormRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DeleteFormRequest
import io.gs2.formation.result.DeleteFormResult

result = client.deleteForm(
    DeleteFormRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DeleteFormRequest
from gs2_formation_client.result import DeleteFormResult

def callback(async_result: AsyncResult[DeleteFormResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.delete_form_async(
    DeleteFormRequest()\
    callback
)
import io.gs2.formation.request.DeleteFormRequest
import io.gs2.formation.result.DeleteFormResult

result = client.deleteForm(
    DeleteFormRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームを削除

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string true フォームの保存領域の名前
index integer true 保存領域のインデックス
パラメータ データ型 説明
item Form フォーム
mold Mold 保存したフォーム
moldModel MoldModel フォームの保存領域
formModel FormModel フォームモデル

deleteFormByUserId

同期処理

from gs2_formation_client.request import DeleteFormByUserIdRequest
from gs2_formation_client.result import DeleteFormByUserIdResult

result = client.delete_form_by_user_id(
    DeleteFormByUserIdRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DeleteFormByUserIdRequest
import io.gs2.formation.result.DeleteFormByUserIdResult

result = client.deleteFormByUserId(
    DeleteFormByUserIdRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DeleteFormByUserIdRequest
from gs2_formation_client.result import DeleteFormByUserIdResult

def callback(async_result: AsyncResult[DeleteFormByUserIdResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.delete_form_by_user_id_async(
    DeleteFormByUserIdRequest()\
    callback
)
import io.gs2.formation.request.DeleteFormByUserIdRequest
import io.gs2.formation.result.DeleteFormByUserIdResult

result = client.deleteFormByUserId(
    DeleteFormByUserIdRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ユーザIDを指定してフォームを削除

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
userId string false ユーザーID
moldName string true フォームの保存領域の名前
index integer true 保存領域のインデックス
パラメータ データ型 説明
item Form フォーム
mold Mold 保存したフォーム
moldModel MoldModel フォームの保存領域
formModel FormModel フォームモデル

deleteFormModelMaster

同期処理

from gs2_formation_client.request import DeleteFormModelMasterRequest
from gs2_formation_client.result import DeleteFormModelMasterResult

result = client.delete_form_model_master(
    DeleteFormModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_form_name('form-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DeleteFormModelMasterRequest
import io.gs2.formation.result.DeleteFormModelMasterResult

result = client.deleteFormModelMaster(
    DeleteFormModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withFormName("form-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DeleteFormModelMasterRequest
from gs2_formation_client.result import DeleteFormModelMasterResult

def callback(async_result: AsyncResult[DeleteFormModelMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.delete_form_model_master_async(
    DeleteFormModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_form_name('form-0001'),
    callback
)
import io.gs2.formation.request.DeleteFormModelMasterRequest
import io.gs2.formation.result.DeleteFormModelMasterResult

result = client.deleteFormModelMaster(
    DeleteFormModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withFormName("form-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームマスターを削除

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
formName string true フォーム名
パラメータ データ型 説明
item FormModelMaster 削除したフォームマスター

deleteMold

同期処理

from gs2_formation_client.request import DeleteMoldRequest
from gs2_formation_client.result import DeleteMoldResult

result = client.delete_mold(
    DeleteMoldRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DeleteMoldRequest
import io.gs2.formation.result.DeleteMoldResult

result = client.deleteMold(
    DeleteMoldRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DeleteMoldRequest
from gs2_formation_client.result import DeleteMoldResult

def callback(async_result: AsyncResult[DeleteMoldResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.delete_mold_async(
    DeleteMoldRequest()\
    callback
)
import io.gs2.formation.request.DeleteMoldRequest
import io.gs2.formation.result.DeleteMoldResult

result = client.deleteMold(
    DeleteMoldRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

保存したフォームを削除

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string true フォームの保存領域の名前
パラメータ データ型 説明
item Mold 保存したフォーム

deleteMoldByUserId

同期処理

from gs2_formation_client.request import DeleteMoldByUserIdRequest
from gs2_formation_client.result import DeleteMoldByUserIdResult

result = client.delete_mold_by_user_id(
    DeleteMoldByUserIdRequest()\
        .with_namespace_name('namespace-0002')\
        .with_user_id('user-0001')\
        .with_mold_name('mold-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DeleteMoldByUserIdRequest
import io.gs2.formation.result.DeleteMoldByUserIdResult

result = client.deleteMoldByUserId(
    DeleteMoldByUserIdRequest()
        .withNamespaceName("namespace-0002")
        .withUserId("user-0001")
        .withMoldName("mold-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DeleteMoldByUserIdRequest
from gs2_formation_client.result import DeleteMoldByUserIdResult

def callback(async_result: AsyncResult[DeleteMoldByUserIdResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.delete_mold_by_user_id_async(
    DeleteMoldByUserIdRequest()\
        .with_namespace_name('namespace-0002')\
        .with_user_id('user-0001')\
        .with_mold_name('mold-0001'),
    callback
)
import io.gs2.formation.request.DeleteMoldByUserIdRequest
import io.gs2.formation.result.DeleteMoldByUserIdResult

result = client.deleteMoldByUserId(
    DeleteMoldByUserIdRequest()
        .withNamespaceName("namespace-0002")
        .withUserId("user-0001")
        .withMoldName("mold-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ユーザIDを指定して保存したフォームを削除

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
userId string false ユーザーID
moldName string true フォームの保存領域の名前
パラメータ データ型 説明
item Mold 保存したフォーム

deleteMoldModelMaster

同期処理

from gs2_formation_client.request import DeleteMoldModelMasterRequest
from gs2_formation_client.result import DeleteMoldModelMasterResult

result = client.delete_mold_model_master(
    DeleteMoldModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_mold_name('mold-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DeleteMoldModelMasterRequest
import io.gs2.formation.result.DeleteMoldModelMasterResult

result = client.deleteMoldModelMaster(
    DeleteMoldModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withMoldName("mold-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DeleteMoldModelMasterRequest
from gs2_formation_client.result import DeleteMoldModelMasterResult

def callback(async_result: AsyncResult[DeleteMoldModelMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.delete_mold_model_master_async(
    DeleteMoldModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_mold_name('mold-0001'),
    callback
)
import io.gs2.formation.request.DeleteMoldModelMasterRequest
import io.gs2.formation.result.DeleteMoldModelMasterResult

result = client.deleteMoldModelMaster(
    DeleteMoldModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withMoldName("mold-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームの保存領域マスターを削除

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string true フォームの保存領域名
パラメータ データ型 説明
item MoldModelMaster 削除したフォームの保存領域マスター

deleteNamespace

同期処理

from gs2_formation_client.request import DeleteNamespaceRequest
from gs2_formation_client.result import DeleteNamespaceResult

result = client.delete_namespace(
    DeleteNamespaceRequest()\
        .with_namespace_name('namespace-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DeleteNamespaceRequest
import io.gs2.formation.result.DeleteNamespaceResult

result = client.deleteNamespace(
    DeleteNamespaceRequest()
        .withNamespaceName("namespace-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DeleteNamespaceRequest
from gs2_formation_client.result import DeleteNamespaceResult

def callback(async_result: AsyncResult[DeleteNamespaceResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.delete_namespace_async(
    DeleteNamespaceRequest()\
        .with_namespace_name('namespace-0001'),
    callback
)
import io.gs2.formation.request.DeleteNamespaceRequest
import io.gs2.formation.result.DeleteNamespaceResult

result = client.deleteNamespace(
    DeleteNamespaceRequest()
        .withNamespaceName("namespace-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ネームスペースを削除

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
パラメータ データ型 説明
item Namespace 削除したネームスペース

describeFormModelMasters

同期処理

from gs2_formation_client.request import DescribeFormModelMastersRequest
from gs2_formation_client.result import DescribeFormModelMastersResult

result = client.describe_form_model_masters(
    DescribeFormModelMastersRequest()\
        .with_namespace_name('namespace-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DescribeFormModelMastersRequest
import io.gs2.formation.result.DescribeFormModelMastersResult

result = client.describeFormModelMasters(
    DescribeFormModelMastersRequest()
        .withNamespaceName("namespace-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DescribeFormModelMastersRequest
from gs2_formation_client.result import DescribeFormModelMastersResult

def callback(async_result: AsyncResult[DescribeFormModelMastersResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.describe_form_model_masters_async(
    DescribeFormModelMastersRequest()\
        .with_namespace_name('namespace-0001'),
    callback
)
import io.gs2.formation.request.DescribeFormModelMastersRequest
import io.gs2.formation.result.DescribeFormModelMastersResult

result = client.describeFormModelMasters(
    DescribeFormModelMastersRequest()
        .withNamespaceName("namespace-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームマスターの一覧を取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
pageToken string false データの取得を開始する位置を指定するトークン
limit long false データの取得件数
パラメータ データ型 説明
items list[FormModelMaster] フォームマスターのリスト
nextPageToken string リストの続きを取得するためのページトークン

describeForms

同期処理

from gs2_formation_client.request import DescribeFormsRequest
from gs2_formation_client.result import DescribeFormsResult

result = client.describe_forms(
    DescribeFormsRequest()\
        .with_namespace_name('namespace-0002')\
        .with_mold_name('mold-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DescribeFormsRequest
import io.gs2.formation.result.DescribeFormsResult

result = client.describeForms(
    DescribeFormsRequest()
        .withNamespaceName("namespace-0002")
        .withMoldName("mold-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DescribeFormsRequest
from gs2_formation_client.result import DescribeFormsResult

def callback(async_result: AsyncResult[DescribeFormsResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.describe_forms_async(
    DescribeFormsRequest()\
        .with_namespace_name('namespace-0002')\
        .with_mold_name('mold-0001'),
    callback
)
import io.gs2.formation.request.DescribeFormsRequest
import io.gs2.formation.result.DescribeFormsResult

result = client.describeForms(
    DescribeFormsRequest()
        .withNamespaceName("namespace-0002")
        .withMoldName("mold-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームの一覧を取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string false フォームの保存領域の名前
pageToken string false データの取得を開始する位置を指定するトークン
limit long false データの取得件数
パラメータ データ型 説明
items list[Form] フォームのリスト
nextPageToken string リストの続きを取得するためのページトークン

describeFormsByUserId

同期処理

from gs2_formation_client.request import DescribeFormsByUserIdRequest
from gs2_formation_client.result import DescribeFormsByUserIdResult

result = client.describe_forms_by_user_id(
    DescribeFormsByUserIdRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DescribeFormsByUserIdRequest
import io.gs2.formation.result.DescribeFormsByUserIdResult

result = client.describeFormsByUserId(
    DescribeFormsByUserIdRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DescribeFormsByUserIdRequest
from gs2_formation_client.result import DescribeFormsByUserIdResult

def callback(async_result: AsyncResult[DescribeFormsByUserIdResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.describe_forms_by_user_id_async(
    DescribeFormsByUserIdRequest()\
    callback
)
import io.gs2.formation.request.DescribeFormsByUserIdRequest
import io.gs2.formation.result.DescribeFormsByUserIdResult

result = client.describeFormsByUserId(
    DescribeFormsByUserIdRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ユーザIDを指定してフォームの一覧を取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string false フォームの保存領域の名前
userId string false ユーザーID
pageToken string false データの取得を開始する位置を指定するトークン
limit long false データの取得件数
パラメータ データ型 説明
items list[Form] フォームのリスト
nextPageToken string リストの続きを取得するためのページトークン

describeMoldModelMasters

同期処理

from gs2_formation_client.request import DescribeMoldModelMastersRequest
from gs2_formation_client.result import DescribeMoldModelMastersResult

result = client.describe_mold_model_masters(
    DescribeMoldModelMastersRequest()\
        .with_namespace_name('namespace-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DescribeMoldModelMastersRequest
import io.gs2.formation.result.DescribeMoldModelMastersResult

result = client.describeMoldModelMasters(
    DescribeMoldModelMastersRequest()
        .withNamespaceName("namespace-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DescribeMoldModelMastersRequest
from gs2_formation_client.result import DescribeMoldModelMastersResult

def callback(async_result: AsyncResult[DescribeMoldModelMastersResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.describe_mold_model_masters_async(
    DescribeMoldModelMastersRequest()\
        .with_namespace_name('namespace-0001'),
    callback
)
import io.gs2.formation.request.DescribeMoldModelMastersRequest
import io.gs2.formation.result.DescribeMoldModelMastersResult

result = client.describeMoldModelMasters(
    DescribeMoldModelMastersRequest()
        .withNamespaceName("namespace-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームの保存領域マスターの一覧を取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
pageToken string false データの取得を開始する位置を指定するトークン
limit long false データの取得件数
パラメータ データ型 説明
items list[MoldModelMaster] フォームの保存領域マスターのリスト
nextPageToken string リストの続きを取得するためのページトークン

describeMoldModels

同期処理

from gs2_formation_client.request import DescribeMoldModelsRequest
from gs2_formation_client.result import DescribeMoldModelsResult

result = client.describe_mold_models(
    DescribeMoldModelsRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DescribeMoldModelsRequest
import io.gs2.formation.result.DescribeMoldModelsResult

result = client.describeMoldModels(
    DescribeMoldModelsRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DescribeMoldModelsRequest
from gs2_formation_client.result import DescribeMoldModelsResult

def callback(async_result: AsyncResult[DescribeMoldModelsResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.describe_mold_models_async(
    DescribeMoldModelsRequest()\
    callback
)
import io.gs2.formation.request.DescribeMoldModelsRequest
import io.gs2.formation.result.DescribeMoldModelsResult

result = client.describeMoldModels(
    DescribeMoldModelsRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームの保存領域の一覧を取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
パラメータ データ型 説明
items list[MoldModel] フォームの保存領域のリスト

describeMolds

同期処理

from gs2_formation_client.request import DescribeMoldsRequest
from gs2_formation_client.result import DescribeMoldsResult

result = client.describe_molds(
    DescribeMoldsRequest()\
        .with_namespace_name('namespace-0002')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DescribeMoldsRequest
import io.gs2.formation.result.DescribeMoldsResult

result = client.describeMolds(
    DescribeMoldsRequest()
        .withNamespaceName("namespace-0002")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DescribeMoldsRequest
from gs2_formation_client.result import DescribeMoldsResult

def callback(async_result: AsyncResult[DescribeMoldsResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.describe_molds_async(
    DescribeMoldsRequest()\
        .with_namespace_name('namespace-0002'),
    callback
)
import io.gs2.formation.request.DescribeMoldsRequest
import io.gs2.formation.result.DescribeMoldsResult

result = client.describeMolds(
    DescribeMoldsRequest()
        .withNamespaceName("namespace-0002"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

保存したフォームの一覧を取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
pageToken string false データの取得を開始する位置を指定するトークン
limit long false データの取得件数
パラメータ データ型 説明
items list[Mold] 保存したフォームのリスト
nextPageToken string リストの続きを取得するためのページトークン

describeMoldsByUserId

同期処理

from gs2_formation_client.request import DescribeMoldsByUserIdRequest
from gs2_formation_client.result import DescribeMoldsByUserIdResult

result = client.describe_molds_by_user_id(
    DescribeMoldsByUserIdRequest()\
        .with_namespace_name('namespace-0002')\
        .with_user_id('user-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DescribeMoldsByUserIdRequest
import io.gs2.formation.result.DescribeMoldsByUserIdResult

result = client.describeMoldsByUserId(
    DescribeMoldsByUserIdRequest()
        .withNamespaceName("namespace-0002")
        .withUserId("user-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DescribeMoldsByUserIdRequest
from gs2_formation_client.result import DescribeMoldsByUserIdResult

def callback(async_result: AsyncResult[DescribeMoldsByUserIdResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.describe_molds_by_user_id_async(
    DescribeMoldsByUserIdRequest()\
        .with_namespace_name('namespace-0002')\
        .with_user_id('user-0001'),
    callback
)
import io.gs2.formation.request.DescribeMoldsByUserIdRequest
import io.gs2.formation.result.DescribeMoldsByUserIdResult

result = client.describeMoldsByUserId(
    DescribeMoldsByUserIdRequest()
        .withNamespaceName("namespace-0002")
        .withUserId("user-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ユーザIDを指定して保存したフォームの一覧を取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
userId string false ユーザーID
pageToken string false データの取得を開始する位置を指定するトークン
limit long false データの取得件数
パラメータ データ型 説明
items list[Mold] 保存したフォームのリスト
nextPageToken string リストの続きを取得するためのページトークン

describeNamespaces

同期処理

from gs2_formation_client.request import DescribeNamespacesRequest
from gs2_formation_client.result import DescribeNamespacesResult

result = client.describe_namespaces(
    DescribeNamespacesRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.DescribeNamespacesRequest
import io.gs2.formation.result.DescribeNamespacesResult

result = client.describeNamespaces(
    DescribeNamespacesRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import DescribeNamespacesRequest
from gs2_formation_client.result import DescribeNamespacesResult

def callback(async_result: AsyncResult[DescribeNamespacesResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.describe_namespaces_async(
    DescribeNamespacesRequest()\
    callback
)
import io.gs2.formation.request.DescribeNamespacesRequest
import io.gs2.formation.result.DescribeNamespacesResult

result = client.describeNamespaces(
    DescribeNamespacesRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ネームスペースの一覧を取得

パラメータ データ型 必須 説明
pageToken string false データの取得を開始する位置を指定するトークン
limit long false データの取得件数
パラメータ データ型 説明
items list[Namespace] ネームスペースのリスト
nextPageToken string リストの続きを取得するためのページトークン

exportMaster

同期処理

from gs2_formation_client.request import ExportMasterRequest
from gs2_formation_client.result import ExportMasterResult

result = client.export_master(
    ExportMasterRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.ExportMasterRequest
import io.gs2.formation.result.ExportMasterResult

result = client.exportMaster(
    ExportMasterRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import ExportMasterRequest
from gs2_formation_client.result import ExportMasterResult

def callback(async_result: AsyncResult[ExportMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.export_master_async(
    ExportMasterRequest()\
    callback
)
import io.gs2.formation.request.ExportMasterRequest
import io.gs2.formation.result.ExportMasterResult

result = client.exportMaster(
    ExportMasterRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

現在有効なフォーム設定のマスターデータをエクスポートします

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
パラメータ データ型 説明
item CurrentFormMaster 現在有効なフォーム設定

getCurrentFormMaster

同期処理

from gs2_formation_client.request import GetCurrentFormMasterRequest
from gs2_formation_client.result import GetCurrentFormMasterResult

result = client.get_current_form_master(
    GetCurrentFormMasterRequest()\
        .with_namespace_name('namespace-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetCurrentFormMasterRequest
import io.gs2.formation.result.GetCurrentFormMasterResult

result = client.getCurrentFormMaster(
    GetCurrentFormMasterRequest()
        .withNamespaceName("namespace-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetCurrentFormMasterRequest
from gs2_formation_client.result import GetCurrentFormMasterResult

def callback(async_result: AsyncResult[GetCurrentFormMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_current_form_master_async(
    GetCurrentFormMasterRequest()\
        .with_namespace_name('namespace-0001'),
    callback
)
import io.gs2.formation.request.GetCurrentFormMasterRequest
import io.gs2.formation.result.GetCurrentFormMasterResult

result = client.getCurrentFormMaster(
    GetCurrentFormMasterRequest()
        .withNamespaceName("namespace-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

現在有効なフォーム設定を取得します

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
パラメータ データ型 説明
item CurrentFormMaster 現在有効なフォーム設定

getForm

同期処理

from gs2_formation_client.request import GetFormRequest
from gs2_formation_client.result import GetFormResult

result = client.get_form(
    GetFormRequest()\
        .with_namespace_name('namespace-0002')\
        .with_mold_name('mold-0001')\
        .with_index(0)
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetFormRequest
import io.gs2.formation.result.GetFormResult

result = client.getForm(
    GetFormRequest()
        .withNamespaceName("namespace-0002")
        .withMoldName("mold-0001")
        .withIndex(0)
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetFormRequest
from gs2_formation_client.result import GetFormResult

def callback(async_result: AsyncResult[GetFormResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_form_async(
    GetFormRequest()\
        .with_namespace_name('namespace-0002')\
        .with_mold_name('mold-0001')\
        .with_index(0),
    callback
)
import io.gs2.formation.request.GetFormRequest
import io.gs2.formation.result.GetFormResult

result = client.getForm(
    GetFormRequest()
        .withNamespaceName("namespace-0002")
        .withMoldName("mold-0001")
        .withIndex(0),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームを取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string true フォームの保存領域の名前
index integer true 保存領域のインデックス
パラメータ データ型 説明
item Form フォーム
mold Mold 保存したフォーム
moldModel MoldModel フォームの保存領域
formModel FormModel フォームモデル

getFormByUserId

同期処理

from gs2_formation_client.request import GetFormByUserIdRequest
from gs2_formation_client.result import GetFormByUserIdResult

result = client.get_form_by_user_id(
    GetFormByUserIdRequest()\
        .with_namespace_name('namespace-0002')\
        .with_user_id('user-0001')\
        .with_mold_name('mold-0001')\
        .with_index(1)
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetFormByUserIdRequest
import io.gs2.formation.result.GetFormByUserIdResult

result = client.getFormByUserId(
    GetFormByUserIdRequest()
        .withNamespaceName("namespace-0002")
        .withUserId("user-0001")
        .withMoldName("mold-0001")
        .withIndex(1)
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetFormByUserIdRequest
from gs2_formation_client.result import GetFormByUserIdResult

def callback(async_result: AsyncResult[GetFormByUserIdResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_form_by_user_id_async(
    GetFormByUserIdRequest()\
        .with_namespace_name('namespace-0002')\
        .with_user_id('user-0001')\
        .with_mold_name('mold-0001')\
        .with_index(1),
    callback
)
import io.gs2.formation.request.GetFormByUserIdRequest
import io.gs2.formation.result.GetFormByUserIdResult

result = client.getFormByUserId(
    GetFormByUserIdRequest()
        .withNamespaceName("namespace-0002")
        .withUserId("user-0001")
        .withMoldName("mold-0001")
        .withIndex(1),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ユーザIDを指定してフォームを取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
userId string false ユーザーID
moldName string true フォームの保存領域の名前
index integer true 保存領域のインデックス
パラメータ データ型 説明
item Form フォーム
mold Mold 保存したフォーム
moldModel MoldModel フォームの保存領域
formModel FormModel フォームモデル

getFormModelMaster

同期処理

from gs2_formation_client.request import GetFormModelMasterRequest
from gs2_formation_client.result import GetFormModelMasterResult

result = client.get_form_model_master(
    GetFormModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_form_name('form-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetFormModelMasterRequest
import io.gs2.formation.result.GetFormModelMasterResult

result = client.getFormModelMaster(
    GetFormModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withFormName("form-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetFormModelMasterRequest
from gs2_formation_client.result import GetFormModelMasterResult

def callback(async_result: AsyncResult[GetFormModelMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_form_model_master_async(
    GetFormModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_form_name('form-0001'),
    callback
)
import io.gs2.formation.request.GetFormModelMasterRequest
import io.gs2.formation.result.GetFormModelMasterResult

result = client.getFormModelMaster(
    GetFormModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withFormName("form-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームマスターを取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
formName string true フォーム名
パラメータ データ型 説明
item FormModelMaster フォームマスター

getMold

同期処理

from gs2_formation_client.request import GetMoldRequest
from gs2_formation_client.result import GetMoldResult

result = client.get_mold(
    GetMoldRequest()\
        .with_namespace_name('namespace-0002')\
        .with_mold_name('mold-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetMoldRequest
import io.gs2.formation.result.GetMoldResult

result = client.getMold(
    GetMoldRequest()
        .withNamespaceName("namespace-0002")
        .withMoldName("mold-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetMoldRequest
from gs2_formation_client.result import GetMoldResult

def callback(async_result: AsyncResult[GetMoldResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_mold_async(
    GetMoldRequest()\
        .with_namespace_name('namespace-0002')\
        .with_mold_name('mold-0001'),
    callback
)
import io.gs2.formation.request.GetMoldRequest
import io.gs2.formation.result.GetMoldResult

result = client.getMold(
    GetMoldRequest()
        .withNamespaceName("namespace-0002")
        .withMoldName("mold-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

保存したフォームを取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string true フォームの保存領域の名前
パラメータ データ型 説明
item Mold 保存したフォーム
moldModel MoldModel フォームの保存領域

getMoldByUserId

同期処理

from gs2_formation_client.request import GetMoldByUserIdRequest
from gs2_formation_client.result import GetMoldByUserIdResult

result = client.get_mold_by_user_id(
    GetMoldByUserIdRequest()\
        .with_namespace_name('namespace-0002')\
        .with_user_id('user-0001')\
        .with_mold_name('mold-0002')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetMoldByUserIdRequest
import io.gs2.formation.result.GetMoldByUserIdResult

result = client.getMoldByUserId(
    GetMoldByUserIdRequest()
        .withNamespaceName("namespace-0002")
        .withUserId("user-0001")
        .withMoldName("mold-0002")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetMoldByUserIdRequest
from gs2_formation_client.result import GetMoldByUserIdResult

def callback(async_result: AsyncResult[GetMoldByUserIdResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_mold_by_user_id_async(
    GetMoldByUserIdRequest()\
        .with_namespace_name('namespace-0002')\
        .with_user_id('user-0001')\
        .with_mold_name('mold-0002'),
    callback
)
import io.gs2.formation.request.GetMoldByUserIdRequest
import io.gs2.formation.result.GetMoldByUserIdResult

result = client.getMoldByUserId(
    GetMoldByUserIdRequest()
        .withNamespaceName("namespace-0002")
        .withUserId("user-0001")
        .withMoldName("mold-0002"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ユーザIDを指定して保存したフォームを取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
userId string false ユーザーID
moldName string true フォームの保存領域の名前
パラメータ データ型 説明
item Mold 保存したフォーム
moldModel MoldModel フォームの保存領域

getMoldModel

同期処理

from gs2_formation_client.request import GetMoldModelRequest
from gs2_formation_client.result import GetMoldModelResult

result = client.get_mold_model(
    GetMoldModelRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetMoldModelRequest
import io.gs2.formation.result.GetMoldModelResult

result = client.getMoldModel(
    GetMoldModelRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetMoldModelRequest
from gs2_formation_client.result import GetMoldModelResult

def callback(async_result: AsyncResult[GetMoldModelResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_mold_model_async(
    GetMoldModelRequest()\
    callback
)
import io.gs2.formation.request.GetMoldModelRequest
import io.gs2.formation.result.GetMoldModelResult

result = client.getMoldModel(
    GetMoldModelRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームの保存領域を取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string true フォームの保存領域名
パラメータ データ型 説明
item MoldModel フォームの保存領域

getMoldModelMaster

同期処理

from gs2_formation_client.request import GetMoldModelMasterRequest
from gs2_formation_client.result import GetMoldModelMasterResult

result = client.get_mold_model_master(
    GetMoldModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_mold_name('mold-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetMoldModelMasterRequest
import io.gs2.formation.result.GetMoldModelMasterResult

result = client.getMoldModelMaster(
    GetMoldModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withMoldName("mold-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetMoldModelMasterRequest
from gs2_formation_client.result import GetMoldModelMasterResult

def callback(async_result: AsyncResult[GetMoldModelMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_mold_model_master_async(
    GetMoldModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_mold_name('mold-0001'),
    callback
)
import io.gs2.formation.request.GetMoldModelMasterRequest
import io.gs2.formation.result.GetMoldModelMasterResult

result = client.getMoldModelMaster(
    GetMoldModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withMoldName("mold-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームの保存領域マスターを取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string true フォームの保存領域名
パラメータ データ型 説明
item MoldModelMaster フォームの保存領域マスター

getNamespace

同期処理

from gs2_formation_client.request import GetNamespaceRequest
from gs2_formation_client.result import GetNamespaceResult

result = client.get_namespace(
    GetNamespaceRequest()\
        .with_namespace_name('namespace-0001')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetNamespaceRequest
import io.gs2.formation.result.GetNamespaceResult

result = client.getNamespace(
    GetNamespaceRequest()
        .withNamespaceName("namespace-0001")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetNamespaceRequest
from gs2_formation_client.result import GetNamespaceResult

def callback(async_result: AsyncResult[GetNamespaceResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_namespace_async(
    GetNamespaceRequest()\
        .with_namespace_name('namespace-0001'),
    callback
)
import io.gs2.formation.request.GetNamespaceRequest
import io.gs2.formation.result.GetNamespaceResult

result = client.getNamespace(
    GetNamespaceRequest()
        .withNamespaceName("namespace-0001"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ネームスペースを取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
パラメータ データ型 説明
item Namespace ネームスペース

getNamespaceStatus

同期処理

from gs2_formation_client.request import GetNamespaceStatusRequest
from gs2_formation_client.result import GetNamespaceStatusResult

result = client.get_namespace_status(
    GetNamespaceStatusRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.GetNamespaceStatusRequest
import io.gs2.formation.result.GetNamespaceStatusResult

result = client.getNamespaceStatus(
    GetNamespaceStatusRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import GetNamespaceStatusRequest
from gs2_formation_client.result import GetNamespaceStatusResult

def callback(async_result: AsyncResult[GetNamespaceStatusResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.get_namespace_status_async(
    GetNamespaceStatusRequest()\
    callback
)
import io.gs2.formation.request.GetNamespaceStatusRequest
import io.gs2.formation.result.GetNamespaceStatusResult

result = client.getNamespaceStatus(
    GetNamespaceStatusRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ネームスペースを取得

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
パラメータ データ型 説明
status string

setCapacityByStampSheet

同期処理

from gs2_formation_client.request import SetCapacityByStampSheetRequest
from gs2_formation_client.result import SetCapacityByStampSheetResult

result = client.set_capacity_by_stamp_sheet(
    SetCapacityByStampSheetRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.SetCapacityByStampSheetRequest
import io.gs2.formation.result.SetCapacityByStampSheetResult

result = client.setCapacityByStampSheet(
    SetCapacityByStampSheetRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import SetCapacityByStampSheetRequest
from gs2_formation_client.result import SetCapacityByStampSheetResult

def callback(async_result: AsyncResult[SetCapacityByStampSheetResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.set_capacity_by_stamp_sheet_async(
    SetCapacityByStampSheetRequest()\
    callback
)
import io.gs2.formation.request.SetCapacityByStampSheetRequest
import io.gs2.formation.result.SetCapacityByStampSheetResult

result = client.setCapacityByStampSheet(
    SetCapacityByStampSheetRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

スタンプシートでキャパシティサイズを設定

パラメータ データ型 必須 説明
stampSheet string true スタンプシート
keyId string true スタンプシートの署名検証に使用する 暗号鍵 のGRN
パラメータ データ型 説明
item Mold 更新後の保存したフォーム
moldModel MoldModel フォームの保存領域

setFormByUserId

同期処理

from gs2_formation_client.request import SetFormByUserIdRequest
from gs2_formation_client.result import SetFormByUserIdResult

result = client.set_form_by_user_id(
    SetFormByUserIdRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.SetFormByUserIdRequest
import io.gs2.formation.result.SetFormByUserIdResult

result = client.setFormByUserId(
    SetFormByUserIdRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import SetFormByUserIdRequest
from gs2_formation_client.result import SetFormByUserIdResult

def callback(async_result: AsyncResult[SetFormByUserIdResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.set_form_by_user_id_async(
    SetFormByUserIdRequest()\
    callback
)
import io.gs2.formation.request.SetFormByUserIdRequest
import io.gs2.formation.result.SetFormByUserIdResult

result = client.setFormByUserId(
    SetFormByUserIdRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ユーザIDを指定してフォームを更新

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
userId string false ユーザーID
moldName string true フォームの保存領域の名前
index integer true 保存領域のインデックス
slots list[Slot] true スロットリスト
パラメータ データ型 説明
item Form フォーム
mold Mold 保存したフォーム
moldModel MoldModel フォームの保存領域
formModel FormModel フォームモデル

setFormWithSignature

同期処理

from gs2_formation_client.request import SetFormWithSignatureRequest
from gs2_formation_client.result import SetFormWithSignatureResult

result = client.set_form_with_signature(
    SetFormWithSignatureRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.SetFormWithSignatureRequest
import io.gs2.formation.result.SetFormWithSignatureResult

result = client.setFormWithSignature(
    SetFormWithSignatureRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import SetFormWithSignatureRequest
from gs2_formation_client.result import SetFormWithSignatureResult

def callback(async_result: AsyncResult[SetFormWithSignatureResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.set_form_with_signature_async(
    SetFormWithSignatureRequest()\
    callback
)
import io.gs2.formation.request.SetFormWithSignatureRequest
import io.gs2.formation.result.SetFormWithSignatureResult

result = client.setFormWithSignature(
    SetFormWithSignatureRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

署名付きスロットを使ってフォームを更新

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string true フォームの保存領域の名前
index integer true 保存領域のインデックス
slots list[SlotWithSignature] true 編成するスロットのリスト
keyId string true 署名の発行に使用した GS2-Key の暗号鍵GRN
パラメータ データ型 説明
item Form フォーム
mold Mold 保存したフォーム
moldModel MoldModel フォームの保存領域
formModel FormModel フォームモデル

setMoldCapacityByUserId

同期処理

from gs2_formation_client.request import SetMoldCapacityByUserIdRequest
from gs2_formation_client.result import SetMoldCapacityByUserIdResult

result = client.set_mold_capacity_by_user_id(
    SetMoldCapacityByUserIdRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.SetMoldCapacityByUserIdRequest
import io.gs2.formation.result.SetMoldCapacityByUserIdResult

result = client.setMoldCapacityByUserId(
    SetMoldCapacityByUserIdRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import SetMoldCapacityByUserIdRequest
from gs2_formation_client.result import SetMoldCapacityByUserIdResult

def callback(async_result: AsyncResult[SetMoldCapacityByUserIdResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.set_mold_capacity_by_user_id_async(
    SetMoldCapacityByUserIdRequest()\
    callback
)
import io.gs2.formation.request.SetMoldCapacityByUserIdRequest
import io.gs2.formation.result.SetMoldCapacityByUserIdResult

result = client.setMoldCapacityByUserId(
    SetMoldCapacityByUserIdRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ユーザIDを指定して保存したフォームのキャパシティを更新

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
userId string false ユーザーID
moldName string true フォームの保存領域の名前
capacity integer true 現在のキャパシティ
パラメータ データ型 説明
item Mold キャパシティを更新した保存したフォーム
moldModel MoldModel フォームの保存領域

updateCurrentFormMaster

同期処理

from gs2_formation_client.request import UpdateCurrentFormMasterRequest
from gs2_formation_client.result import UpdateCurrentFormMasterResult

result = client.update_current_form_master(
    UpdateCurrentFormMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .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}')
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.UpdateCurrentFormMasterRequest
import io.gs2.formation.result.UpdateCurrentFormMasterResult

result = client.updateCurrentFormMaster(
    UpdateCurrentFormMasterRequest()
        .withNamespaceName("namespace-0001")
        .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}")
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import UpdateCurrentFormMasterRequest
from gs2_formation_client.result import UpdateCurrentFormMasterResult

def callback(async_result: AsyncResult[UpdateCurrentFormMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.update_current_form_master_async(
    UpdateCurrentFormMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .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}'),
    callback
)
import io.gs2.formation.request.UpdateCurrentFormMasterRequest
import io.gs2.formation.result.UpdateCurrentFormMasterResult

result = client.updateCurrentFormMaster(
    UpdateCurrentFormMasterRequest()
        .withNamespaceName("namespace-0001")
        .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}"),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)
Type: GS2::Formation::CurrentFormMaster
Properties:
  NamespaceName: String
  Settings: String

現在有効なフォーム設定を更新します

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
settings string true マスターデータ
パラメータ データ型 説明
item CurrentFormMaster 更新した現在有効なフォーム設定

updateCurrentFormMasterFromGitHub

同期処理

from gs2_formation_client.request import UpdateCurrentFormMasterFromGitHubRequest
from gs2_formation_client.result import UpdateCurrentFormMasterFromGitHubResult

result = client.update_current_form_master_from_git_hub(
    UpdateCurrentFormMasterFromGitHubRequest()\
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.UpdateCurrentFormMasterFromGitHubRequest
import io.gs2.formation.result.UpdateCurrentFormMasterFromGitHubResult

result = client.updateCurrentFormMasterFromGitHub(
    UpdateCurrentFormMasterFromGitHubRequest()
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import UpdateCurrentFormMasterFromGitHubRequest
from gs2_formation_client.result import UpdateCurrentFormMasterFromGitHubResult

def callback(async_result: AsyncResult[UpdateCurrentFormMasterFromGitHubResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.update_current_form_master_from_git_hub_async(
    UpdateCurrentFormMasterFromGitHubRequest()\
    callback
)
import io.gs2.formation.request.UpdateCurrentFormMasterFromGitHubRequest
import io.gs2.formation.result.UpdateCurrentFormMasterFromGitHubResult

result = client.updateCurrentFormMasterFromGitHub(
    UpdateCurrentFormMasterFromGitHubRequest(),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

現在有効なフォーム設定を更新します

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
checkoutSetting GitHubCheckoutSetting true GitHubからマスターデータをチェックアウトしてくる設定
パラメータ データ型 説明
item CurrentFormMaster 更新した現在有効なフォーム設定

updateFormModelMaster

同期処理

from gs2_formation_client.request import UpdateFormModelMasterRequest
from gs2_formation_client.result import UpdateFormModelMasterResult

result = client.update_form_model_master(
    UpdateFormModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_form_name('form-0001')\
        .with_description('description1')\
        .with_metadata('FORM_0001')\
        .with_slots([
Object("SlotModel", {"name": 'slot-1101'}), 
Object("SlotModel", {"name": 'slot-1102', "metadata": 'METADATA_1102'})
])
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.UpdateFormModelMasterRequest
import io.gs2.formation.result.UpdateFormModelMasterResult

result = client.updateFormModelMaster(
    UpdateFormModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withFormName("form-0001")
        .withDescription("description1")
        .withMetadata("FORM_0001")
        .withSlots(new [] {
Object("SlotModel", {"name": "slot-1101"}), 
Object("SlotModel", {"name": "slot-1102", "metadata": "METADATA_1102"})
})
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import UpdateFormModelMasterRequest
from gs2_formation_client.result import UpdateFormModelMasterResult

def callback(async_result: AsyncResult[UpdateFormModelMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.update_form_model_master_async(
    UpdateFormModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_form_name('form-0001')\
        .with_description('description1')\
        .with_metadata('FORM_0001')\
        .with_slots([
Object("SlotModel", {"name": 'slot-1101'}), 
Object("SlotModel", {"name": 'slot-1102', "metadata": 'METADATA_1102'})
]),
    callback
)
import io.gs2.formation.request.UpdateFormModelMasterRequest
import io.gs2.formation.result.UpdateFormModelMasterResult

result = client.updateFormModelMaster(
    UpdateFormModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withFormName("form-0001")
        .withDescription("description1")
        .withMetadata("FORM_0001")
        .withSlots(new [] {
Object("SlotModel", {"name": "slot-1101"}), 
Object("SlotModel", {"name": "slot-1102", "metadata": "METADATA_1102"})
}),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームマスターを更新

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
formName string true フォーム名
description string false フォームマスターの説明
metadata string false フォームのメタデータ
slots list[SlotModel] true スロットリスト
パラメータ データ型 説明
item FormModelMaster 更新したフォームマスター

updateMoldModelMaster

同期処理

from gs2_formation_client.request import UpdateMoldModelMasterRequest
from gs2_formation_client.result import UpdateMoldModelMasterResult

result = client.update_mold_model_master(
    UpdateMoldModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_mold_name('mold-0001')\
        .with_form_model_id(form_model1['formModelId'])\
        .with_initial_max_capacity(5)\
        .with_max_capacity(15)
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.UpdateMoldModelMasterRequest
import io.gs2.formation.result.UpdateMoldModelMasterResult

result = client.updateMoldModelMaster(
    UpdateMoldModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withMoldName("mold-0001")
        .withFormModelId(form_model1.get'FormModelId())
        .withInitialMaxCapacity(5)
        .withMaxCapacity(15)
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import UpdateMoldModelMasterRequest
from gs2_formation_client.result import UpdateMoldModelMasterResult

def callback(async_result: AsyncResult[UpdateMoldModelMasterResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.update_mold_model_master_async(
    UpdateMoldModelMasterRequest()\
        .with_namespace_name('namespace-0001')\
        .with_mold_name('mold-0001')\
        .with_form_model_id(form_model1['formModelId'])\
        .with_initial_max_capacity(5)\
        .with_max_capacity(15),
    callback
)
import io.gs2.formation.request.UpdateMoldModelMasterRequest
import io.gs2.formation.result.UpdateMoldModelMasterResult

result = client.updateMoldModelMaster(
    UpdateMoldModelMasterRequest()
        .withNamespaceName("namespace-0001")
        .withMoldName("mold-0001")
        .withFormModelId(form_model1.get'FormModelId())
        .withInitialMaxCapacity(5)
        .withMaxCapacity(15),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

フォームの保存領域マスターを更新

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
moldName string true フォームの保存領域名
description string false フォームの保存領域マスターの説明
metadata string false フォームの保存領域のメタデータ
formModelId string true フォームマスター
initialMaxCapacity integer true フォームを保存できる初期キャパシティ
maxCapacity integer true フォームを保存できるキャパシティ
パラメータ データ型 説明
item MoldModelMaster 更新したフォームの保存領域マスター

updateNamespace

同期処理

from gs2_formation_client.request import UpdateNamespaceRequest
from gs2_formation_client.result import UpdateNamespaceResult

result = client.update_namespace(
    UpdateNamespaceRequest()\
        .with_namespace_name('namespace-0001')\
        .with_description('description1')\
        .with_log_setting(Object("LogSetting", {"loggingNamespaceId": 'grn:gs2:ap-northeast-1:{ownerId}:log:namespace-0001'}))
)
# エラー発生時には例外が発生
# result が成功結果が格納
import io.gs2.formation.request.UpdateNamespaceRequest
import io.gs2.formation.result.UpdateNamespaceResult

result = client.updateNamespace(
    UpdateNamespaceRequest()
        .withNamespaceName("namespace-0001")
        .withDescription("description1")
        .withLogSetting(Object("LogSetting", {"loggingNamespaceId": "grn:gs2:ap-northeast-1:{ownerId}:log:namespace-0001"}))
)
// エラー発生時には例外が発生
// result が成功結果が格納
同期APIは実装されていません

非同期処理

from gs2_formation_client.request import UpdateNamespaceRequest
from gs2_formation_client.result import UpdateNamespaceResult

def callback(async_result: AsyncResult[UpdateNamespaceResult]):
    if async_result.error:
        #  エラー発生時には async_result.error に例外が格納
        raise async_result.error
    # async_result.result が成功結果格納

result = client.update_namespace_async(
    UpdateNamespaceRequest()\
        .with_namespace_name('namespace-0001')\
        .with_description('description1')\
        .with_log_setting(Object("LogSetting", {"loggingNamespaceId": 'grn:gs2:ap-northeast-1:{ownerId}:log:namespace-0001'})),
    callback
)
import io.gs2.formation.request.UpdateNamespaceRequest
import io.gs2.formation.result.UpdateNamespaceResult

result = client.updateNamespace(
    UpdateNamespaceRequest()
        .withNamespaceName("namespace-0001")
        .withDescription("description1")
        .withLogSetting(Object("LogSetting", {"loggingNamespaceId": "grn:gs2:ap-northeast-1:{ownerId}:log:namespace-0001"})),
    (result) => {
        if (result.getError() != null) {
            // エラー発生時には result.getError() で例外を取得
            throw result.getError()
        }
        // result.getResult() で成功結果を取得
    }
)

GS2-Deploy から利用できません

ネームスペースを更新

パラメータ データ型 必須 説明
namespaceName string true ネームスペース名
description string false ネームスペースの説明
updateMoldScript ScriptSetting false キャパシティを更新するときに実行するスクリプト
updateFormScript ScriptSetting false フォームを更新するときに実行するスクリプト
logSetting LogSetting false ログの出力設定
パラメータ データ型 説明
item Namespace 更新したネームスペース

GS2-Script トリガーイベント

UpdateMoldTriggerScript

スクリプトの雛形

namespace = args['namespace']  -- type: Namespace
mold = args['mold']  -- type: Mold

result = {
    permit=  -- type: boolean
}

キャパシティ更新時 に実行されるGS2-Script

パラメータ データ型 説明
namespace Namespace ネームスペース
mold Mold 保存したフォーム
パラメータ データ型 説明
permit boolean キャパシティ更新 を許可するか

UpdateMoldDoneTriggerScript

スクリプトの雛形

namespace = args['namespace']  -- type: Namespace
mold = args['mold']  -- type: Mold

result = {
}

キャパシティ更新完了時 に実行されるGS2-Script

パラメータ データ型 説明
namespace Namespace ネームスペース
mold Mold 保存したフォーム
パラメータ データ型 説明

UpdateFormTriggerScript

スクリプトの雛形

namespace = args['namespace']  -- type: Namespace
mold = args['mold']  -- type: Mold
form = args['form']  -- type: Form

result = {
    permit=  -- type: boolean
}

フォーム更新時 に実行されるGS2-Script

パラメータ データ型 説明
namespace Namespace ネームスペース
mold Mold 保存したフォーム
form Form フォーム
パラメータ データ型 説明
permit boolean フォーム更新 を許可するか

UpdateFormDoneTriggerScript

スクリプトの雛形

namespace = args['namespace']  -- type: Namespace
mold = args['mold']  -- type: Mold
form = args['form']  -- type: Form

result = {
}

フォーム更新完了時 に実行されるGS2-Script

パラメータ データ型 説明
namespace Namespace ネームスペース
mold Mold 保存したフォーム
form Form フォーム
パラメータ データ型 説明

マスターデータフォーマット

CurrentFormMaster

{
  "version": "2019-09-09"
  "moldModels": [
    {
      "name": "[string] フォームの保存領域名",
      "metadata": "[string] メタデータ",
      "initialMaxCapacity": "[integer] フォームを保存できる初期キャパシティ",
      "maxCapacity": "[integer] フォームを保存できるキャパシティ",
      "formModel": [
        {
          "name": "[string] フォームの種類名",
          "metadata": "[string] フォームの種類のメタデータ"
        }
      ]
    }
  ]
}

現在有効なフォーム設定

エクスポートしたマスターデータを、現在有効なフォーム設定としてインポートして使用します。

GS2-Formation の制限・制約

利用いただくにあたって注意いただく制限・制約はありません