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

概要

呼び出しの処理時に API スタブがリクエストおよびシステムの状態にアクセスできるようにします。

特定の API スタブでは、API 呼び出しをトリガしたリクエスト(たとえば、user_service_stub には継続 URL を生成するリクエストのホスト名が必要です)またはシステム状態(たとえば modules_stub)に関する情報にアクセスする必要があります。

他のスタブ(taskqueue_stub、channel_stub など)は、システム内でリクエストをディスパッチできる必要があります。

RequestInfo サブクラスのインスタンスは、これらの機能を必要とするスタブに渡されます。

内容

exception google.appengine.api.request_info.BackgroundThreadLimitReachedErrorソース

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

インスタンスが、そのバックグラウンド スレッドの容量です。

class google.appengine.api.request_info.Dispatcherソース

ベース: object

リクエストに関する情報を提供し、モジュールにリクエストをディスパッチします。

add_async_request(method, relative_url, headers, body, source_ip, module_name=None, version=None, instance_id=None)ソース

HTTP リクエストを非同期でディスパッチします。

パラメータ
  • method - リクエストの HTTP メソッドを含む文字列。

  • relative_url - リクエストのパスとクエリ文字列を含む文字列。

  • headers - キーと値の両方が文字列である (key, value) タプルのリスト。

  • body - リクエストの本文を含む文字列。

  • source_ip - リクエストのソース IP アドレス。

  • module_name - このリクエストを処理するモジュール名を含むオプションの文字列。設定されていない場合、リクエストはデフォルト モジュールにディスパッチされます。

  • version - このリクエストを処理するバージョンを含むオプションの文字列。設定されていない場合、リクエストはデフォルト バージョンにディスパッチされます。

  • instance_id - このリクエストを処理するインスタンスの instance_id を含むオプションの文字列。設定されていない場合、リクエストは、モジュールとバージョンの負荷分散に従ってディスパッチされます。

add_event(runnable, eta, service=None, event_id=None)ソース

指定された時刻に実行される呼び出し可能オブジェクトを追加します。

パラメータ
  • runnable - 指定された時刻に呼び出す呼び出し可能オブジェクト。

  • eta - イベントを実行する時間を含む整数値(エポック時刻からの秒数)。

  • service - このイベントを所有するサービスの名前を含む文字列。これは、event_id が設定されている場合に設定する必要があります。

  • event_id - イベントの ID を含む文字列。設定されている場合は、update_event に渡して、イベントの実行時刻を変更できます。

add_request(method, relative_url, headers, body, source_ip, module_name=None, version=None, instance_id=None)ソース

HTTP リクエストを処理します。

パラメータ
  • method - リクエストの HTTP メソッドを含む文字列。

  • relative_url - リクエストのパスとクエリ文字列を含む文字列。

  • headers - キーと値の両方が文字列である (key, value) タプルのリスト。

  • body - リクエストの本文を含む文字列。

  • source_ip - リクエストのソース IP アドレス。

  • module_name - このリクエストを処理するモジュール名を含むオプションの文字列。設定されていない場合、リクエストはデフォルト モジュールにディスパッチされます。

  • version - このリクエストを処理するバージョンを含むオプションの文字列。設定されていない場合、リクエストはデフォルト バージョンにディスパッチされます。

  • instance_id - このリクエストを処理するインスタンスの instance_id を含むオプションの文字列。設定されていない場合、リクエストは、モジュールとバージョンの負荷分散に従ってディスパッチされます。

戻り値

HTTP リクエストのレスポンス情報を含む ResponseTuple。

get_default_version(module)ソース

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

パラメータ

module - モジュールの名前を含む文字列。

戻り値

指定したモジュールのデフォルトのバージョンを含む文字列。

発生

ModuleDoesNotExistError - モジュールが存在しません。

get_hostname(module, version, instance=None)ソース

(module, version, instance) タプルのホスト名を返します。

instance が設定されている場合は、特定のインスタンスのホスト名が返されます。それ以外の場合は、負荷分散のためにホスト名が返されます。

パラメータ
  • module - モジュールの名前を含む文字列。

  • version - バージョンを含む文字列。

  • instance - インスタンス ID を含むオプションの文字列。

戻り値

ホスト名を含む文字列。

発生
get_module_names()ソース

モジュール名のリストを返します。

get_num_instances(module, version)ソース

モジュールのバージョンに対して実行中のインスタンスの数を取得します。

パラメータ
  • module - モジュールの名前を含む文字列。

  • version - バージョンを含む文字列。

発生
get_versions(module)ソース

モジュールのバージョンのリストを返します。

パラメータ

module - モジュールの名前を含む文字列。

戻り値

指定されたモジュールのバージョンを含む文字列のリスト。

発生

ModuleDoesNotExistError - モジュールが存在しません。

send_background_request(module_name, version, instance, background_request_id)ソース

バックグラウンド スレッド リクエストをディスパッチします。

パラメータ
  • module_name - このリクエストを処理するモジュール名を含む文字列。

  • version - このリクエストを処理するバージョンを含む文字列。

  • instance - このリクエストを処理するインスタンス。

  • background_request_id - 一意のバックグラウンド スレッド リクエスト識別子を含む文字列。

発生
set_num_instances(module, version, instances)ソース

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

パラメータ
  • module - モジュールの名前を含む文字列。

  • version - バージョンを含む文字列。

  • instances - 実行するインスタンスの数を含む整数値。

発生
start_version(module, version)ソース

バージョンを開始します。

パラメータ
  • module - モジュールの名前を含む文字列。

  • version - バージョンを含む文字列。

発生
stop_version(module, version)ソース

バージョンを停止します。

パラメータ
  • module - モジュールの名前を含む文字列。

  • version - バージョンを含む文字列。

発生
update_event(eta, service, event_id)ソース

スケジュールされたイベントの eta を更新します。

パラメータ
  • eta - イベントを実行する時間を含む整数値(エポック時刻からの秒数)。

  • service - このイベントを所有するサービスの名前を含む文字列。

  • event_id - 更新するイベントの ID を含む文字列。

exception google.appengine.api.request_info.Errorソース

ベース: exceptions.Exception

exception google.appengine.api.request_info.InvalidInstanceIdErrorソース

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

指定されたインスタンス ID が無効です。

exception google.appengine.api.request_info.ModuleDoesNotExistErrorソース

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

指定されたモジュールが存在しません。

exception google.appengine.api.request_info.NotSupportedWithAutoScalingErrorソース

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

リクエストされたオペレーションは、自動スケーリング モジュールでサポートされていません。

class google.appengine.api.request_info.RequestInfoソース

ベース: object

スタブが API 呼び出しを行うリクエストにリンクされた状態を参照できるようにします。

get_dispatcher()ソース

ディスパッチャを返します。

戻り値

Dispatcher インスタンス。

get_instance(request_id)ソース

このリクエストを処理するインスタンスを返します。

パラメータ

request_id - API 呼び出しを行うリクエストの文字列 ID。

戻り値

このリクエストを処理するインスタンスの不透明表現。インスタンスが必要なディスパッチャ メソッドにのみ渡す必要があります。

get_module(request_id)ソース

このリクエストを処理しているモジュールの名前を返します。

パラメータ

request_id - API 呼び出しを行うリクエストの文字列 ID。

戻り値

モジュール名を含む文字列。

get_request_environ(request_id)ソース

リクエストの WSGI environ を含む dict を返します。

get_request_url(request_id)ソース

リクエストの URL (「http://localhost:8080/foo?bar=baz」など)を返します。

パラメータ

request_id - API 呼び出しを行うリクエストの文字列 ID。

戻り値

リクエストの URL(文字列)。

get_version(request_id)ソース

このリクエストを処理しているモジュールのバージョンを返します。

パラメータ

request_id - API 呼び出しを行うリクエストの文字列 ID。

戻り値

バージョンを含む文字列。

register_request_id(environ, request_id)ソース

dev_appserver からのシミュレートされた HTTP リクエストを登録します。

サブクラスは、実装を提供する必要はありません。

パラメータ
  • environ - PEP-333 で定義されているリクエストの environ dict。

  • request_id - API 呼び出しを行うリクエストの文字列 ID。

class google.appengine.api.request_info.ResponseTuple(status, headers, content)ソース

ベース: tuple

content

フィールド番号 2 のエイリアス

headers

フィールド番号 1 のエイリアス

status

フィールド番号 0 のエイリアス

exception google.appengine.api.request_info.VersionAlreadyStartedErrorソース

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

バージョンはすでに開始されています。

exception google.appengine.api.request_info.VersionAlreadyStoppedErrorソース

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

バージョンはすでに停止されています。

exception google.appengine.api.request_info.VersionDoesNotExistErrorソース

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

提供されたバージョンは存在しません。

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

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

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