==================================================== GS2-Lock ==================================================== **Create Client** .. code-block:: lua lock_client = client('lock') .. contents:: 目次 :local: :depth: 2 Method ==================================================== ---------------------------------------------------- create_lock_pool ---------------------------------------------------- .. code-block:: lua response = lock_client:create_lock_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ロックプールを新規作成します Request ---------------------------------------------------- .. include:: control/CreateLockPoolRequest.rst Response ---------------------------------------------------- .. include:: control/CreateLockPoolResult.rst ---------------------------------------------------- delete_lock_pool ---------------------------------------------------- .. code-block:: lua response = lock_client:delete_lock_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ロックプールを削除します Request ---------------------------------------------------- .. include:: control/DeleteLockPoolRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- describe_lock_pool ---------------------------------------------------- .. code-block:: lua response = lock_client:describe_lock_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ロックプールの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeLockPoolRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeLockPoolResult.rst ---------------------------------------------------- describe_service_class ---------------------------------------------------- .. code-block:: lua response = lock_client:describe_service_class(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end サービスクラスの一覧を取得します Request ---------------------------------------------------- .. include:: control/DescribeServiceClassRequest.rst Response ---------------------------------------------------- .. include:: control/DescribeServiceClassResult.rst ---------------------------------------------------- get_lock_pool ---------------------------------------------------- .. code-block:: lua response = lock_client:get_lock_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ロックプールを取得します Request ---------------------------------------------------- .. include:: control/GetLockPoolRequest.rst Response ---------------------------------------------------- .. include:: control/GetLockPoolResult.rst ---------------------------------------------------- get_lock_pool_status ---------------------------------------------------- .. code-block:: lua response = lock_client:get_lock_pool_status(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ロックプールの状態を取得します Request ---------------------------------------------------- .. include:: control/GetLockPoolStatusRequest.rst Response ---------------------------------------------------- .. include:: control/GetLockPoolStatusResult.rst ---------------------------------------------------- lock ---------------------------------------------------- .. code-block:: lua response = lock_client:lock(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ロックを取得します。 Request ---------------------------------------------------- .. include:: control/LockRequest.rst Response ---------------------------------------------------- .. include:: control/LockResult.rst ---------------------------------------------------- lock_by_user ---------------------------------------------------- .. code-block:: lua response = lock_client:lock_by_user(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ロックを取得します。 Request ---------------------------------------------------- .. include:: control/LockByUserRequest.rst Response ---------------------------------------------------- .. include:: control/LockByUserResult.rst ---------------------------------------------------- unlock ---------------------------------------------------- .. code-block:: lua response = lock_client:unlock(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end アンロックします。 Request ---------------------------------------------------- .. include:: control/UnlockRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- unlock_by_user ---------------------------------------------------- .. code-block:: lua response = lock_client:unlock_by_user(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end アンロックします。 Request ---------------------------------------------------- .. include:: control/UnlockByUserRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- unlock_force_by_user ---------------------------------------------------- .. code-block:: lua response = lock_client:unlock_force_by_user(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end 強制的にアンロックします。 このAPIを利用すると、トランザクションやロックカウンターの状態を無視して強制的にアンロック出来ます。 Request ---------------------------------------------------- .. include:: control/UnlockForceByUserRequest.rst Response ---------------------------------------------------- None ---------------------------------------------------- update_lock_pool ---------------------------------------------------- .. code-block:: lua response = lock_client:update_lock_pool(request) if response.isError then -- エラー処理 -- print(response.statusCode) print(response.errorMessage) else -- 正常処理 -- print(response.result) end ロックプールを更新します Request ---------------------------------------------------- .. include:: control/UpdateLockPoolRequest.rst Response ---------------------------------------------------- .. include:: control/UpdateLockPoolResult.rst Model ==================================================== ---------------------------------------------------- LockPool ---------------------------------------------------- .. include:: model/LockPool.rst ---------------------------------------------------- Lock ---------------------------------------------------- .. include:: model/Lock.rst