StaticFilesHandler.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<StaticFilesHandler.Builder>
    - - com.google.appengine.v1.StaticFilesHandler.Builder

All Implemented Interfaces:: StaticFilesHandlerOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: StaticFilesHandler

public static final class StaticFilesHandler.Builder
extends GeneratedMessageV3.Builder<StaticFilesHandler.Builder>
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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`StaticFilesHandler.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`StaticFilesHandler`	`build()`
`StaticFilesHandler`	`buildPartial()`
`StaticFilesHandler.Builder`	`clear()`
`StaticFilesHandler.Builder`	`clearApplicationReadable()` Whether files should also be uploaded as code data.
`StaticFilesHandler.Builder`	`clearExpiration()` Time a static file served by this handler should be cached by web proxies and browsers.
`StaticFilesHandler.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`StaticFilesHandler.Builder`	`clearHttpHeaders()`
`StaticFilesHandler.Builder`	`clearMimeType()` MIME type used to serve all files served by this handler.
`StaticFilesHandler.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`StaticFilesHandler.Builder`	`clearPath()` Path to the static files matched by the URL pattern, from the application root directory.
`StaticFilesHandler.Builder`	`clearRequireMatchingFile()` Whether this handler should match the request if the file referenced by the handler does not exist.
`StaticFilesHandler.Builder`	`clearUploadPathRegex()` Regular expression that matches the file paths for all files that should be referenced by this handler.
`StaticFilesHandler.Builder`	`clone()`
`boolean`	`containsHttpHeaders(java.lang.String key)` HTTP headers to use for all responses from these URLs.
`boolean`	`getApplicationReadable()` Whether files should also be uploaded as code data.
`StaticFilesHandler`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`Duration`	`getExpiration()` Time a static file served by this handler should be cached by web proxies and browsers.
`Duration.Builder`	`getExpirationBuilder()` Time a static file served by this handler should be cached by web proxies and browsers.
`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.
`ByteString`	`getMimeTypeBytes()` MIME type used to serve all files served by this handler.
`java.util.Map<java.lang.String,java.lang.String>`	`getMutableHttpHeaders()` Deprecated.
`java.lang.String`	`getPath()` Path to the static files matched by the URL pattern, from the application root directory.
`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.
`java.lang.String`	`getUploadPathRegex()` Regular expression that matches the file paths for all files that should be referenced by this handler.
`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.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected MapField`	`internalGetMapField(int number)`
`protected MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`StaticFilesHandler.Builder`	`mergeExpiration(Duration value)` Time a static file served by this handler should be cached by web proxies and browsers.
`StaticFilesHandler.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`StaticFilesHandler.Builder`	`mergeFrom(Message other)`
`StaticFilesHandler.Builder`	`mergeFrom(StaticFilesHandler other)`
`StaticFilesHandler.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`StaticFilesHandler.Builder`	`putAllHttpHeaders(java.util.Map<java.lang.String,java.lang.String> values)` HTTP headers to use for all responses from these URLs.
`StaticFilesHandler.Builder`	`putHttpHeaders(java.lang.String key, java.lang.String value)` HTTP headers to use for all responses from these URLs.
`StaticFilesHandler.Builder`	`removeHttpHeaders(java.lang.String key)` HTTP headers to use for all responses from these URLs.
`StaticFilesHandler.Builder`	`setApplicationReadable(boolean value)` Whether files should also be uploaded as code data.
`StaticFilesHandler.Builder`	`setExpiration(Duration.Builder builderForValue)` Time a static file served by this handler should be cached by web proxies and browsers.
`StaticFilesHandler.Builder`	`setExpiration(Duration value)` Time a static file served by this handler should be cached by web proxies and browsers.
`StaticFilesHandler.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`StaticFilesHandler.Builder`	`setMimeType(java.lang.String value)` MIME type used to serve all files served by this handler.
`StaticFilesHandler.Builder`	`setMimeTypeBytes(ByteString value)` MIME type used to serve all files served by this handler.
`StaticFilesHandler.Builder`	`setPath(java.lang.String value)` Path to the static files matched by the URL pattern, from the application root directory.
`StaticFilesHandler.Builder`	`setPathBytes(ByteString value)` Path to the static files matched by the URL pattern, from the application root directory.
`StaticFilesHandler.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`StaticFilesHandler.Builder`	`setRequireMatchingFile(boolean value)` Whether this handler should match the request if the file referenced by the handler does not exist.
`StaticFilesHandler.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`
`StaticFilesHandler.Builder`	`setUploadPathRegex(java.lang.String value)` Regular expression that matches the file paths for all files that should be referenced by this handler.
`StaticFilesHandler.Builder`	`setUploadPathRegexBytes(ByteString value)` Regular expression that matches the file paths for all files that should be referenced by this handler.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

internalGetMutableMapField
```
protected MapField internalGetMutableMapField(int number)
```
Overrides:

internalGetMutableMapField in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

clear
```
public StaticFilesHandler.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

getDefaultInstanceForType
```
public StaticFilesHandler getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public StaticFilesHandler build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public StaticFilesHandler buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public StaticFilesHandler.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

setField

public StaticFilesHandler.Builder setField(Descriptors.FieldDescriptor field,
                                           java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

clearField
```
public StaticFilesHandler.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

clearOneof
```
public StaticFilesHandler.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

setRepeatedField

public StaticFilesHandler.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                                   int index,
                                                   java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

addRepeatedField

public StaticFilesHandler.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                   java.lang.Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

mergeFrom
```
public StaticFilesHandler.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<StaticFilesHandler.Builder>

mergeFrom

public StaticFilesHandler.Builder mergeFrom(StaticFilesHandler other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<StaticFilesHandler.Builder>

mergeFrom

public StaticFilesHandler.Builder mergeFrom(CodedInputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<StaticFilesHandler.Builder>
Throws:: java.io.IOException

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.

string path = 1;

Specified by:: getPath in interface StaticFilesHandlerOrBuilder

getPathBytes

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

string path = 1;

Specified by:: getPathBytes in interface StaticFilesHandlerOrBuilder

setPath

public StaticFilesHandler.Builder setPath(java.lang.String value)

 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.

string path = 1;

clearPath

public StaticFilesHandler.Builder clearPath()

 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.

string path = 1;

setPathBytes

public StaticFilesHandler.Builder setPathBytes(ByteString value)

 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.

string path = 1;

getUploadPathRegex

public java.lang.String getUploadPathRegex()

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

string upload_path_regex = 2;

Specified by:: getUploadPathRegex in interface StaticFilesHandlerOrBuilder

getUploadPathRegexBytes

public ByteString getUploadPathRegexBytes()

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

string upload_path_regex = 2;

Specified by:: getUploadPathRegexBytes in interface StaticFilesHandlerOrBuilder

setUploadPathRegex

public StaticFilesHandler.Builder setUploadPathRegex(java.lang.String value)

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

string upload_path_regex = 2;

clearUploadPathRegex

public StaticFilesHandler.Builder clearUploadPathRegex()

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

string upload_path_regex = 2;

setUploadPathRegexBytes

public StaticFilesHandler.Builder setUploadPathRegexBytes(ByteString value)

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

string upload_path_regex = 2;

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

clearHttpHeaders

public StaticFilesHandler.Builder clearHttpHeaders()

removeHttpHeaders

public StaticFilesHandler.Builder removeHttpHeaders(java.lang.String key)

 HTTP headers to use for all responses from these URLs.

map<string, string> http_headers = 3;

getMutableHttpHeaders

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

Deprecated.

Use alternate mutation accessors instead.

putHttpHeaders

public StaticFilesHandler.Builder putHttpHeaders(java.lang.String key,
                                                 java.lang.String value)

 HTTP headers to use for all responses from these URLs.

map<string, string> http_headers = 3;

putAllHttpHeaders

public StaticFilesHandler.Builder putAllHttpHeaders(java.util.Map<java.lang.String,java.lang.String> values)

 HTTP headers to use for all responses from these URLs.

map<string, string> http_headers = 3;

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.

string mime_type = 4;

Specified by:: getMimeType in interface StaticFilesHandlerOrBuilder

getMimeTypeBytes

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

string mime_type = 4;

Specified by:: getMimeTypeBytes in interface StaticFilesHandlerOrBuilder

setMimeType

public StaticFilesHandler.Builder setMimeType(java.lang.String value)

 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 mime_type = 4;

clearMimeType

public StaticFilesHandler.Builder clearMimeType()

 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 mime_type = 4;

setMimeTypeBytes

public StaticFilesHandler.Builder setMimeTypeBytes(ByteString value)

 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 mime_type = 4;