google.appengine.api.modules.modules モジュール

概要

アプリのサービス(モジュール)とバージョンを制御するメソッドを公開します。

サービスは以前はモジュールと呼ばれていましたが、API メソッドにはその名前がそのまま反映されていました。詳細とコードのサンプルについては、モジュール API の使用をご覧ください。

内容

例外 google.appengine.api.modules.modules.Error ソース

ベース: exceptions.Exception

このモジュールのエラーの基本クラスです。

例外 google.appengine.api.modules.modules.InvalidModuleError ソース

ベース: google.appengine.api.modules.modules.Error

指定されたモジュールはシステムに認識されません。

例外 google.appengine.api.modules.modules.InvalidVersionError ソース

ベース: google.appengine.api.modules.modules.Error

指定されたモジュール バージョンはシステムに認識されません。

例外 google.appengine.api.modules.modules.InvalidInstancesError ソース

ベース: google.appengine.api.modules.modules.Error

指定されたインスタンスの値は無効です。

例外 google.appengine.api.modules.modules.UnexpectedStateError ソース

ベース: google.appengine.api.modules.modules.Error

モジュールの起動 / 停止時に予期しない現在の状態が見つかりました。

例外 google.appengine.api.modules.modules.TransientError ソース

ベース: google.appengine.api.modules.modules.Error

一時的なエラーが発生しました。オペレーションを再試行してください。

google.appengine.api.modules.modules.get_current_module_name() ソース

現在のインスタンスのモジュール名を返します。

アプリケーション「my-app」のモジュール「module5」のバージョン「v1」の場合、この関数は「module5」を返します。

google.appengine.api.modules.modules.get_current_version_name() ソース

現在のインスタンスのバージョンを返します。

アプリケーション「my-app」のモジュール「module5」のバージョン「v1」の場合、この関数は「v1」を返します。

google.appengine.api.modules.modules.get_current_instance_id() ソース

現在のインスタンスの ID を返します。

アプリケーション「my-app」のモジュール「module5」のバージョン「v1」のインスタンス 2 の場合、この関数は「2」を返します。

これは自動的に拡張されたモジュールに対してのみ有効です。それ以外の場合は、None が返されます。

戻り値

インスタンス ID が含まれる文字列、または自動的に拡張されたモジュールでない場合は None。

google.appengine.api.modules.modules.get_modules() ソース

アプリケーションのすべてのモジュールのリストを返します。

戻り値

このアプリケーションに関連するモジュールの名前が含まれる文字列のリスト

。「デフォルト」のモジュールが存在する場合はそれが含まれます。この関数を呼び出すインスタンスに関連付けられているモジュールの名前も含まれます。

google.appengine.api.modules.modules.get_versions(module=None) ソース

指定されたモジュール バージョンのリストを返します。

パラメータ

module – バージョンを取得するモジュール。None の場合、現在のモジュールが使用されます。

戻り値

モジュールに関連付けられているバージョンの名前が含まれる文字列のリスト。現在のバージョンもこのリストに含まれます。

発生
  • 指定されたモジュールが有効でない場合は InvalidModuleError、

  • 情報の取得に問題がある場合は TransientError。

google.appengine.api.modules.modules.get_default_version(module=None) ソース

モジュールのデフォルト バージョンの名前を返します。

パラメータ

module – デフォルトのバージョンを取得するモジュール。None の場合、現在のモジュールが使用されます。

戻り値

モジュールのデフォルト バージョンの名前が含まれる文字列。

発生
  • 指定されたモジュールが有効でない場合は InvalidModuleError、

  • デフォルト バージョンが見つからなかった場合は InvalidVersionError。

google.appengine.api.modules.modules.get_num_instances(module=None, version=None) ソース

指定されたモジュール バージョンに設定されているインスタンスの数を返します。

これは固定モジュールに対してのみ有効です。自動的に拡張されたモジュールではエラーが発生します。将来、自動的に拡張されたモジュールがサポートされる可能性があります。

パラメータ
  • module – この情報を取得するモジュールの名前が含まれる文字列。None の場合、現在のインスタンスのモジュールが使用されます。

  • version – この情報を取得するバージョンの名前が含まれる文字列。None の場合、現在のインスタンスのバージョンが使用されます。そのバージョンが他のモジュールに存在しない場合、InvalidVersionError が発生します。

戻り値

指定されたモジュール バージョンで設定されているインスタンスの数。

発生

入力が無効な場合は InvalidVersionError。

google.appengine.api.modules.modules.set_num_instances(instances, module=None, version=None) ソース

モジュールとバージョンのインスタンス数を設定します。

パラメータ
  • instances – 設定するインスタンス数。

  • module – インスタンスの数を設定するモジュール。None の場合、現在のモジュールが使用されます。

  • version – インスタンスの数を設定します。None の場合、現在のバージョンが使用されます。

発生
  • 指定されたモジュール バージョンが有効でない場合は InvalidVersionError、

  • 変更の永続化に問題がある場合は TransientError。

  • 指定されたインスタンス タイプが無効な場合は TypeError。

google.appengine.api.modules.modules.set_num_instances_async(instances, module=None, version=None) ソース

モジュール バージョンのインスタンス数を設定する UserRPC を返します。

パラメータ
  • instances – 設定するインスタンス数。

  • module – インスタンスの数を設定するモジュール。None の場合、現在のモジュールが使用されます。

  • version – インスタンスの数を設定します。None の場合、現在のバージョンが使用されます。

戻り値

モジュール バージョンのインスタンス数を設定する UserRPC。

google.appengine.api.modules.modules.start_version(module, version) ソース

指定されたバージョンのモジュールのインスタンスをすべて起動します。

パラメータ
  • module – 影響を受けるモジュールの名前が含まれる文字列。

  • version – 開始するモジュール バージョンの名前が含まれる文字列。

発生
  • 指定されたモジュール バージョンが無効な場合は InvalidVersionError。

  • 変更の永続化に問題がある場合は TransientError。

google.appengine.api.modules.modules.start_version_async(module, version) ソース

指定されたモジュール バージョンのすべてのインスタンスを開始する UserRPC を返します。

パラメータ
  • module – 影響を受けるモジュールの名前が含まれる文字列。

  • version – 開始するモジュール バージョンの名前が含まれる文字列。

戻り値

指定されたモジュール バージョンのすべてのインスタンスを開始する UserRPC。

google.appengine.api.modules.modules.stop_version(module=None, version=None) ソース

指定されたバージョンのモジュールのすべてのインスタンスを停止します。

パラメータ
  • module – 影響を受けるモジュール。None の場合、現在のモジュールが使用されます。

  • version – 影響を受けるモジュール バージョン。None の場合、現在のバージョンが使用されます。

発生
  • 指定されたモジュール バージョンが無効な場合は InvalidVersionError。

  • 変更の永続化に問題がある場合は TransientError。

google.appengine.api.modules.modules.stop_version_async(module=None, version=None) ソース

指定されたモジュール バージョンのすべてのインスタンスを停止するための UserRPC を返します。

パラメータ
  • module – 影響を受けるモジュール。None の場合、現在のモジュールが使用されます。

  • version – 影響を受けるモジュール バージョン。None の場合、現在のバージョンが使用されます。

戻り値

指定されたモジュール バージョンのすべてのインスタンスを停止するための UserRPC。

google.appengine.api.modules.modules.get_hostname(module=None, version=None, instance=None) ソース

モジュールへの接続に使用するホスト名を返します。

パラメータ
  • module – モジュール名。None の場合、現在のインスタンスのモジュールを使用します。

  • version – バージョンの名前。バージョンが None の場合、現在のインスタンスのバージョンを使用します。ターゲット モジュールにそのバージョンが存在する場合はそれを使用するか、そうでない場合はターゲット モジュールのデフォルト バージョンを使用します。

  • instance – ホスト名を指定するインスタンス。インスタンスが None の場合、モジュールの負荷分散されたホスト名が返されます。ターゲット モジュールが固定モジュールでない場合、インスタンスは有効とみなされません。

戻り値

指定されたモジュール / バージョン / インスタンスとの通信に使用できる有効な正規ホスト名。例: 0.v1.module5.myapp.appspot.com

発生
  • InvalidModuleError - 指定されたモジュール バージョンが無効な場合

  • InvalidInstancesError – 指定されたインスタンス値が無効な場合。

  • TypeError – 指定されたインスタンス タイプが無効な場合。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Python の App Engine スタンダード環境