google.appengine.api.files.gs module

Summary

Files API.

Deprecated since version 1.8.1: Use Google Cloud Storage Client library instead.

Google Storage specific Files API calls.

Contents

google.appengine.api.files.gs.create(filename, mime_type='application/octet-stream', acl=None, cache_control=None, content_encoding=None, content_disposition=None, user_metadata=None)source

Create a writable googlestore file.

Parameters

  • filename โ€“ Google Storage object name (/gs/bucket/object)

  • mime_type โ€“ Blob content MIME type as string.

  • acl โ€“ Canned acl to apply to the object as per: https://cloud.google.com/storage/docs/xml-api/reference-headers#xgoogacl If not specified (or set to None), default object acl is used.

  • cache_control โ€“ Cache control header to set when serving through Google storage. If not specified, default of 3600 seconds is used.

  • content_encoding โ€“ If object is compressed, specify the compression method here to set the header correctly when served through Google Storage.

  • content_disposition โ€“ Header to use when serving through Google Storage.

  • user_metadata โ€“ Dictionary specifying key value pairs to apply to the object. Each key is prefixed with x-goog-meta- when served through Google Storage.

Returns

A writable file name for a Google Storage file. This file can be opened for write by File API open function. To read the file call file::open with the plain Google Storage filename (/gs/bucket/object).