Google Cloud Appengine Admin V1 Client - Class StaticFilesHandler (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class StaticFilesHandler.

Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.

Generated from protobuf message google.appengine.v1.StaticFilesHandler

Namespace

Google \ Cloud \ AppEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ path string

Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.

↳ upload_path_regex string

Regular expression that matches the file paths for all files that should be referenced by this handler.

↳ http_headers array|Google\Protobuf\Internal\MapField

HTTP headers to use for all responses from these URLs.

↳ mime_type string

MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.

↳ expiration Google\Protobuf\Duration

Time a static file served by this handler should be cached by web proxies and browsers.

↳ require_matching_file bool

Whether this handler should match the request if the file referenced by the handler does not exist.

↳ application_readable bool

Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.

getPath

Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.

Returns
Type Description
string

setPath

Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.

Parameter
Name Description
var string
Returns
Type Description
$this

getUploadPathRegex

Regular expression that matches the file paths for all files that should be referenced by this handler.

Returns
Type Description
string

setUploadPathRegex

Regular expression that matches the file paths for all files that should be referenced by this handler.

Parameter
Name Description
var string
Returns
Type Description
$this

getHttpHeaders

HTTP headers to use for all responses from these URLs.

Returns
Type Description
Google\Protobuf\Internal\MapField

setHttpHeaders

HTTP headers to use for all responses from these URLs.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getMimeType

MIME type used to serve all files served by this handler.

Defaults to file-specific MIME types, which are derived from each file's filename extension.

Returns
Type Description
string

setMimeType

MIME type used to serve all files served by this handler.

Defaults to file-specific MIME types, which are derived from each file's filename extension.

Parameter
Name Description
var string
Returns
Type Description
$this

getExpiration

Time a static file served by this handler should be cached by web proxies and browsers.

Returns
Type Description
Google\Protobuf\Duration|null

hasExpiration

clearExpiration

setExpiration

Time a static file served by this handler should be cached by web proxies and browsers.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getRequireMatchingFile

Whether this handler should match the request if the file referenced by the handler does not exist.

Returns
Type Description
bool

setRequireMatchingFile

Whether this handler should match the request if the file referenced by the handler does not exist.

Parameter
Name Description
var bool
Returns
Type Description
$this

getApplicationReadable

Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.

Returns
Type Description
bool

setApplicationReadable

Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.

Parameter
Name Description
var bool
Returns
Type Description
$this