com.google.appengine.v1

Class StaticFilesHandler

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.appengine.v1.StaticFilesHandler

All Implemented Interfaces:

StaticFilesHandlerOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class StaticFilesHandler
extends com.google.protobuf.GeneratedMessageV3
implements StaticFilesHandlerOrBuilder

 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.
 

Protobuf type google.appengine.v1.StaticFilesHandler

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticFilesHandler.Builder Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPLICATION_READABLE_FIELD_NUMBER
static int	EXPIRATION_FIELD_NUMBER
static int	HTTP_HEADERS_FIELD_NUMBER
static int	MIME_TYPE_FIELD_NUMBER
static int	PATH_FIELD_NUMBER
static int	REQUIRE_MATCHING_FILE_FIELD_NUMBER
static int	UPLOAD_PATH_REGEX_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsHttpHeaders(java.lang.String key) HTTP headers to use for all responses from these URLs.
boolean	equals(java.lang.Object obj)
boolean	getApplicationReadable() Whether files should also be uploaded as code data.
static StaticFilesHandler	getDefaultInstance()
StaticFilesHandler	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Duration	getExpiration() Time a static file served by this handler should be cached by web proxies and browsers.
com.google.protobuf.DurationOrBuilder	getExpirationOrBuilder() Time a static file served by this handler should be cached by web proxies and browsers.
java.util.Map<java.lang.String,java.lang.String>	getHttpHeaders() Deprecated.
int	getHttpHeadersCount() HTTP headers to use for all responses from these URLs.
java.util.Map<java.lang.String,java.lang.String>	getHttpHeadersMap() HTTP headers to use for all responses from these URLs.
java.lang.String	getHttpHeadersOrDefault(java.lang.String key, java.lang.String defaultValue) HTTP headers to use for all responses from these URLs.
java.lang.String	getHttpHeadersOrThrow(java.lang.String key) HTTP headers to use for all responses from these URLs.
java.lang.String	getMimeType() MIME type used to serve all files served by this handler.
com.google.protobuf.ByteString	getMimeTypeBytes() MIME type used to serve all files served by this handler.
com.google.protobuf.Parser<StaticFilesHandler>	getParserForType()
java.lang.String	getPath() Path to the static files matched by the URL pattern, from the application root directory.
com.google.protobuf.ByteString	getPathBytes() 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.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
java.lang.String	getUploadPathRegex() Regular expression that matches the file paths for all files that should be referenced by this handler.
com.google.protobuf.ByteString	getUploadPathRegexBytes() Regular expression that matches the file paths for all files that should be referenced by this handler.
boolean	hasExpiration() Time a static file served by this handler should be cached by web proxies and browsers.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static StaticFilesHandler.Builder	newBuilder()
static StaticFilesHandler.Builder	newBuilder(StaticFilesHandler prototype)
StaticFilesHandler.Builder	newBuilderForType()
protected StaticFilesHandler.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static StaticFilesHandler	parseDelimitedFrom(java.io.InputStream input)
static StaticFilesHandler	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StaticFilesHandler	parseFrom(byte[] data)
static StaticFilesHandler	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StaticFilesHandler	parseFrom(com.google.protobuf.ByteString data)
static StaticFilesHandler	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StaticFilesHandler	parseFrom(com.google.protobuf.CodedInputStream input)
static StaticFilesHandler	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StaticFilesHandler	parseFrom(java.io.InputStream input)
static StaticFilesHandler	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StaticFilesHandler>	parser()
StaticFilesHandler.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER

See Also:

Constant Field Values

UPLOAD_PATH_REGEX_FIELD_NUMBER

public static final int UPLOAD_PATH_REGEX_FIELD_NUMBER

See Also:

Constant Field Values

HTTP_HEADERS_FIELD_NUMBER

public static final int HTTP_HEADERS_FIELD_NUMBER

See Also:

Constant Field Values

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

EXPIRATION_FIELD_NUMBER

public static final int EXPIRATION_FIELD_NUMBER

See Also:

Constant Field Values

REQUIRE_MATCHING_FILE_FIELD_NUMBER

public static final int REQUIRE_MATCHING_FILE_FIELD_NUMBER

See Also:

Constant Field Values

APPLICATION_READABLE_FIELD_NUMBER

public static final int APPLICATION_READABLE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPath

public java.lang.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.
 

optional string path = 1;

Specified by:

getPath in interface StaticFilesHandlerOrBuilder

getPathBytes

public com.google.protobuf.ByteString getPathBytes()

 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.
 

optional string path = 1;

Specified by:

getPathBytes in interface StaticFilesHandlerOrBuilder

getUploadPathRegex

public java.lang.String getUploadPathRegex()

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

optional string upload_path_regex = 2;

Specified by:

getUploadPathRegex in interface StaticFilesHandlerOrBuilder

getUploadPathRegexBytes

public com.google.protobuf.ByteString getUploadPathRegexBytes()

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

optional string upload_path_regex = 2;

Specified by:

getUploadPathRegexBytes in interface StaticFilesHandlerOrBuilder

getHttpHeadersCount

public int getHttpHeadersCount()

Description copied from interface: StaticFilesHandlerOrBuilder

 HTTP headers to use for all responses from these URLs.
 

map<string, string> http_headers = 3;

Specified by:

getHttpHeadersCount in interface StaticFilesHandlerOrBuilder

containsHttpHeaders

public boolean containsHttpHeaders(java.lang.String key)

 HTTP headers to use for all responses from these URLs.
 

map<string, string> http_headers = 3;

Specified by:

containsHttpHeaders in interface StaticFilesHandlerOrBuilder

getHttpHeaders

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getHttpHeaders()

Deprecated.

Use getHttpHeadersMap() instead.

Specified by:

getHttpHeaders in interface StaticFilesHandlerOrBuilder

getHttpHeadersMap

public java.util.Map<java.lang.String,java.lang.String> getHttpHeadersMap()

 HTTP headers to use for all responses from these URLs.
 

map<string, string> http_headers = 3;

Specified by:

getHttpHeadersMap in interface StaticFilesHandlerOrBuilder

getHttpHeadersOrDefault

public java.lang.String getHttpHeadersOrDefault(java.lang.String key,
                                                java.lang.String defaultValue)

 HTTP headers to use for all responses from these URLs.
 

map<string, string> http_headers = 3;

Specified by:

getHttpHeadersOrDefault in interface StaticFilesHandlerOrBuilder

getHttpHeadersOrThrow

public java.lang.String getHttpHeadersOrThrow(java.lang.String key)

 HTTP headers to use for all responses from these URLs.
 

map<string, string> http_headers = 3;

Specified by:

getHttpHeadersOrThrow in interface StaticFilesHandlerOrBuilder

getMimeType

public java.lang.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.
 

optional string mime_type = 4;

Specified by:

getMimeType in interface StaticFilesHandlerOrBuilder

getMimeTypeBytes

public com.google.protobuf.ByteString getMimeTypeBytes()

 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.
 

optional string mime_type = 4;

Specified by:

getMimeTypeBytes in interface StaticFilesHandlerOrBuilder

hasExpiration

public boolean hasExpiration()

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

optional .google.protobuf.Duration expiration = 5;

Specified by:

hasExpiration in interface StaticFilesHandlerOrBuilder

getExpiration

public com.google.protobuf.Duration getExpiration()

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

optional .google.protobuf.Duration expiration = 5;

Specified by:

getExpiration in interface StaticFilesHandlerOrBuilder

getExpirationOrBuilder

public com.google.protobuf.DurationOrBuilder getExpirationOrBuilder()

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

optional .google.protobuf.Duration expiration = 5;

Specified by:

getExpirationOrBuilder in interface StaticFilesHandlerOrBuilder

getRequireMatchingFile

public boolean getRequireMatchingFile()

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

optional bool require_matching_file = 6;

Specified by:

getRequireMatchingFile in interface StaticFilesHandlerOrBuilder

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.
 

optional bool application_readable = 7;

Specified by:

getApplicationReadable in interface StaticFilesHandlerOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static StaticFilesHandler parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticFilesHandler parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticFilesHandler parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticFilesHandler parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StaticFilesHandler parseFrom(java.io.InputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static StaticFilesHandler parseFrom(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static StaticFilesHandler parseDelimitedFrom(java.io.InputStream input)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static StaticFilesHandler parseDelimitedFrom(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static StaticFilesHandler parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static StaticFilesHandler parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public StaticFilesHandler.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StaticFilesHandler.Builder newBuilder()

newBuilder

public static StaticFilesHandler.Builder newBuilder(StaticFilesHandler prototype)

toBuilder

public StaticFilesHandler.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StaticFilesHandler.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static StaticFilesHandler getDefaultInstance()

parser

public static com.google.protobuf.Parser<StaticFilesHandler> parser()

getParserForType

public com.google.protobuf.Parser<StaticFilesHandler> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public StaticFilesHandler getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder