com.google.api.services.appengine.v1.model

Class StaticFilesHandler

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.appengine.v1.model.StaticFilesHandler

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class StaticFilesHandler
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the App Engine Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
StaticFilesHandler()

Method Summary

Modifier and Type	Method and Description
StaticFilesHandler	clone()
Boolean	getApplicationReadable() Whether files should also be uploaded as code data.
String	getExpiration() Time a static file served by this handler should be cached by web proxies and browsers.
Map<String,String>	getHttpHeaders() HTTP headers to use for all responses from these URLs.
String	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.
String	getPath() Path to the static files matched by the URL pattern, from the application root directory.
Boolean	getRequireMatchingFile() Whether this handler should match the request if the file referenced by the handler does not exist.
String	getUploadPathRegex() Regular expression that matches the file paths for all files that should be referenced by this handler.
StaticFilesHandler	set(String fieldName, Object value)
StaticFilesHandler	setApplicationReadable(Boolean applicationReadable) Whether files should also be uploaded as code data.
StaticFilesHandler	setExpiration(String expiration) Time a static file served by this handler should be cached by web proxies and browsers.
StaticFilesHandler	setHttpHeaders(Map<String,String> httpHeaders) HTTP headers to use for all responses from these URLs.
StaticFilesHandler	setMimeType(String mimeType) 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.
StaticFilesHandler	setPath(String path) Path to the static files matched by the URL pattern, from the application root directory.
StaticFilesHandler	setRequireMatchingFile(Boolean requireMatchingFile) Whether this handler should match the request if the file referenced by the handler does not exist.
StaticFilesHandler	setUploadPathRegex(String uploadPathRegex) Regular expression that matches the file paths for all files that should be referenced by this handler.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

StaticFilesHandler

public StaticFilesHandler()

Method Detail

getApplicationReadable

public Boolean 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:

value or null for none

setApplicationReadable

public StaticFilesHandler setApplicationReadable(Boolean applicationReadable)

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.

Parameters:

applicationReadable - applicationReadable or null for none

getExpiration

public String getExpiration()

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

Returns:

value or null for none

setExpiration

public StaticFilesHandler setExpiration(String expiration)

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

Parameters:

expiration - expiration or null for none

getHttpHeaders

public Map<String,String> getHttpHeaders()

HTTP headers to use for all responses from these URLs.

Returns:

value or null for none

setHttpHeaders

public StaticFilesHandler setHttpHeaders(Map<String,String> httpHeaders)

HTTP headers to use for all responses from these URLs.

Parameters:

httpHeaders - httpHeaders or null for none

getMimeType

public String 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:

value or null for none

setMimeType

public StaticFilesHandler setMimeType(String mimeType)

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.

Parameters:

mimeType - mimeType or null for none

getPath

public String 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:

value or null for none

setPath

public StaticFilesHandler setPath(String path)

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.

Parameters:

path - path or null for none

getRequireMatchingFile

public Boolean getRequireMatchingFile()

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

Returns:

value or null for none

setRequireMatchingFile

public StaticFilesHandler setRequireMatchingFile(Boolean requireMatchingFile)

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

Parameters:

requireMatchingFile - requireMatchingFile or null for none

getUploadPathRegex

public String getUploadPathRegex()

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

Returns:

value or null for none

setUploadPathRegex

public StaticFilesHandler setUploadPathRegex(String uploadPathRegex)

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

Parameters:

uploadPathRegex - uploadPathRegex or null for none

set

public StaticFilesHandler set(String fieldName,
                              Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public StaticFilesHandler clone()

Overrides:

clone in class com.google.api.client.json.GenericJson