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

概要

Blobstore API。

このモジュールには、Blobstore API とのインターフェースに使用できるメソッドが含まれています。モジュールでは db.Key のような blob キーを表すクラスが定義されます。

内容

exception google.appengine.api.blobstore.blobstore.BlobFetchSizeTooLargeErrorソース

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

ブロックが大きすぎて取得できませんでした。

class google.appengine.api.blobstore.blobstore.BlobKey(blob_key)ソース

ベース: オブジェクト

Blobstore の blob を識別するために使用されるキー。

このオブジェクトは Blobstore API によって内部でアプリケーションの blob を識別するために使用される文字列をラップします。BlobKey は基盤となる BlobReference エンティティのエンティティの名前に対応します。

このクラスは google.appengine.ext.db と google.appengine.ext.blobstore の両方で API で公開されます。

ToXml()ソース
exception google.appengine.api.blobstore.blobstore.BlobNotFoundErrorソース

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

blob が存在しません。

exception google.appengine.api.blobstore.blobstore.DataIndexOutOfRangeErrorソース

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

インデックスにアクセスできませんでした。

指定されたインデックスが範囲外か、または順序が間違っています。

exception google.appengine.api.blobstore.blobstore.PermissionDeniedErrorソース

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

オペレーションは完了しませんでした。必要な権限を確認してください。

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

ベース: exceptions.Exception

ベース blobstore のエラータイプ。

exception google.appengine.api.blobstore.blobstore.InternalErrorソース

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

内部エラーが発生しました。

google.appengine.api.blobstore.blobstore.create_rpc(deadline=None, callback=None)ソース

Blobstore API で使用する RPC オブジェクトを作成します。

パラメータ
  • deadline - オプションで秒単位でオペレーションの制限時間を指定します。デフォルト値はシステム固有の制限時間(通常は 5 秒)です。

  • callback - オプションで完了時に呼び出すことができます。

戻り値

このサービスに特化した apiproxy_stub_map.UserRPC オブジェクト。

google.appengine.api.blobstore.blobstore.create_upload_url(success_path, max_bytes_per_blob=None, max_bytes_total=None, rpc=None, gs_bucket_name=None)ソース

POST フォームのアップロード URL を作成します。

パラメータ
  • success_path - POST 呼び出しが成功してアップロードが完了したときに呼び出すアプリケーション内のパス。

  • max_bytes_per_blob - アップロードに含まれる 1 つの blob の最大サイズ(バイト単位)。最大サイズがない場合は None です。

  • max_bytes_total - アップロード内のすべての blob を集約したサイズが、なり得る最大サイズ(バイト単位)。最大サイズがない場合は None です。

  • rpc - オプションの UserRPC オブジェクト。

  • gs_bucket_name - blob をアップロードする Google Cloud Storage バケット名。アプリケーションのサービス アカウントには、このバケットに書き込むための適切な権限が必要です。バケット名は bucket/path/ 形式にできます。この場合、インクルードされたパスはアップロードされたオブジェクト名の先頭に追加されます。

戻り値

アップロード URL。

発生
  • TypeError - max_bytes_per_blob または max_bytes_total が整数型でない場合。

  • ValueError - max_bytes_per_blob または max_bytes_total が正の値でない場合。

google.appengine.api.blobstore.blobstore.create_upload_url_async(success_path, max_bytes_per_blob=None, max_bytes_total=None, rpc=None, gs_bucket_name=None)ソース

POST フォームのアップロード URL を非同期で作成します。

パラメータ
  • success_path - POST 呼び出しが成功してアップロードが完了したときに呼び出されるアプリケーション内のパス。

  • max_bytes_per_blob - アップロードに含まれる 1 つの blob の最大サイズ(バイト単位)。最大サイズがない場合は None です。

  • max_bytes_total - アップロード内のすべての blob を集約したサイズが、なり得る最大サイズ(バイト単位)。最大サイズがない場合は None です。

  • rpc - オプションの UserRPC オブジェクト。

  • gs_bucket_name - blob をアップロードする Google Cloud Storage バケット名。アプリケーションのサービス アカウントには、このバケットに書き込むための適切な権限が必要です。バケット名は bucket/path/ 形式にできます。この場合、インクルードされたパスはアップロードされたオブジェクト名の先頭に追加されます。

戻り値

結果がアップロード URL になる UserRPC。

発生
  • TypeError - max_bytes_per_blob または max_bytes_total が整数型でない場合。

  • ValueError - max_bytes_per_blob または max_bytes_total が正の値でない場合。

google.appengine.api.blobstore.blobstore.delete(blob_keys, rpc=None, _token=None)ソース

Blobstore から blob を削除します。

パラメータ
  • blob_keys - 単一の BlobKey インスタンスまたは blob キーのリスト。blob キーは文字列か BlobKey のインスタンスのどちらかです。

  • rpc - オプションの UserRPC オブジェクト。

戻り値

なし。

google.appengine.api.blobstore.blobstore.delete_async(blob_keys, rpc=None, _token=None)ソース

Blobstore から blob を非同期的に削除します。

パラメータ
  • blob_keys - 単一の BlobKey インスタンスまたは blob キーのリスト。blob キーは文字列か BlobKey のインスタンスのどちらかです。

  • rpc - オプションの UserRPC オブジェクト。

戻り値

結果が None になる UserRPC。

google.appengine.api.blobstore.blobstore.fetch_data(blob_key, start_index, end_index, rpc=None)ソース

blob のデータを取得します。

パラメータ
  • blob - データを取得する blob の BlobKey、文字列、または BlobKey の Unicode 表現。

  • start_index - 取得する blob データの開始インデックス値。この引数は負の値に設定することはできません。

  • end_index - 取得する blob データの終了インデックス値(終端を含まない)。この引数は start_index 値以上である必要があります。

  • rpc - オプションの UserRPC オブジェクト。

戻り値

blob の部分データを含む文字列。

google.appengine.api.blobstore.blobstore.fetch_data_async(blob_key, start_index, end_index, rpc=None)ソース

blob のデータを非同期的に取得します。

パラメータ
  • blob - データを取得する blob の BlobKey、文字列、または BlobKey の Unicode 表現。

  • start_index - 取得する blob データの開始インデックス値。この引数は負の値に設定することはできません。

  • end_index - 取得する blob データの終了インデックス値(終端を含まない)。この引数は start_index 値以上である必要があります。

  • rpc - オプションの UserRPC オブジェクト。

戻り値

結果が fetch_data() によって返される文字列になる UserRPC。

google.appengine.api.blobstore.blobstore.create_gs_key(filename, rpc=None)ソース

Google Cloud Storage ファイルのエンコードされたキーを作成します。

将来の使用のためにこのキーを保持すると安全です。

パラメータ
  • filename - キーを作成する対象となる Google Cloud Storage オブジェクトのファイル名。

  • rpc - オプションの UserRPC オブジェクト。

戻り値

暗号化された BlobKey 文字列。

google.appengine.api.blobstore.blobstore.create_gs_key_async(filename, rpc=None)ソース

Google Cloud Storage ファイルのエンコードされたキーを非同期に作成します。

将来の使用のためにこのキーを保持すると安全です。

パラメータ
  • filename - キーを作成する対象となる Google Cloud Storage オブジェクトのファイル名。

  • rpc - オプションの UserRPC オブジェクト。

戻り値

結果が create_gs_key() によって返される文字列になる UserRPC。

発生
  • TypeError - filename が文字列でない場合。

  • ValueError - filename/gs/bucket_name/object_name 形式でない場合。

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

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

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