App Engine v1 API - Class StaticFilesHandler (2.3.0)

public sealed class StaticFilesHandler : IMessage<StaticFilesHandler>, IEquatable<StaticFilesHandler>, IDeepCloneable<StaticFilesHandler>, IBufferMessage, IMessage

Reference documentation and code samples for the App Engine v1 API 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.

Inheritance

object > StaticFilesHandler

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

StaticFilesHandler()

public StaticFilesHandler()

StaticFilesHandler(StaticFilesHandler)

public StaticFilesHandler(StaticFilesHandler other)
Parameter
Name Description
other StaticFilesHandler

Properties

ApplicationReadable

public bool ApplicationReadable { get; set; }

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.

Property Value
Type Description
bool

Expiration

public Duration Expiration { get; set; }

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

Property Value
Type Description
Duration

HttpHeaders

public MapField<string, string> HttpHeaders { get; }

HTTP headers to use for all responses from these URLs.

Property Value
Type Description
MapFieldstringstring

MimeType

public string MimeType { get; set; }

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.

Property Value
Type Description
string

Path

public string Path { get; set; }

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.

Property Value
Type Description
string

RequireMatchingFile

public bool RequireMatchingFile { get; set; }

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

Property Value
Type Description
bool

UploadPathRegex

public string UploadPathRegex { get; set; }

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

Property Value
Type Description
string