- 2.49.0 (latest)
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.4
- 2.2.0
- 2.1.10
- 0.2.0
public static final class StaticFilesHandler.Builder extends GeneratedMessageV3.Builder<StaticFilesHandler.Builder> implements StaticFilesHandlerOrBuilderFiles 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StaticFilesHandler.BuilderImplements
StaticFilesHandlerOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StaticFilesHandler.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
build()
public StaticFilesHandler build()| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler | |
buildPartial()
public StaticFilesHandler buildPartial()| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler | |
clear()
public StaticFilesHandler.Builder clear()| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
clearApplicationReadable()
public StaticFilesHandler.Builder clearApplicationReadable()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.
bool application_readable = 7;
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
clearExpiration()
public StaticFilesHandler.Builder clearExpiration()Time a static file served by this handler should be cached by web proxies and browsers.
.google.protobuf.Duration expiration = 5;
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
clearField(Descriptors.FieldDescriptor field)
public StaticFilesHandler.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
clearHttpHeaders()
public StaticFilesHandler.Builder clearHttpHeaders()| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public StaticFilesHandler.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
clearRequireMatchingFile()
public StaticFilesHandler.Builder clearRequireMatchingFile()Whether this handler should match the request if the file referenced by the handler does not exist.
bool require_matching_file = 6;
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
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;
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
clone()
public StaticFilesHandler.Builder clone()| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
containsHttpHeaders(String key)
public boolean containsHttpHeaders(String key)HTTP headers to use for all responses from these URLs.
map<string, string> http_headers = 3;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
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.
bool application_readable = 7;
| Returns | |
|---|---|
| Type | Description |
boolean | The applicationReadable. |
getDefaultInstanceForType()
public StaticFilesHandler getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getExpiration()
public Duration getExpiration()Time a static file served by this handler should be cached by web proxies and browsers.
.google.protobuf.Duration expiration = 5;
| Returns | |
|---|---|
| Type | Description |
Duration | The expiration. |
getExpirationBuilder()
public Duration.Builder getExpirationBuilder()Time a static file served by this handler should be cached by web proxies and browsers.
.google.protobuf.Duration expiration = 5;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getExpirationOrBuilder()
public DurationOrBuilder getExpirationOrBuilder()Time a static file served by this handler should be cached by web proxies and browsers.
.google.protobuf.Duration expiration = 5;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder | |
getHttpHeaders()
public Map<String,String> getHttpHeaders()Use #getHttpHeadersMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getHttpHeadersCount()
public int getHttpHeadersCount()HTTP headers to use for all responses from these URLs.
map<string, string> http_headers = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
getHttpHeadersMap()
public Map<String,String> getHttpHeadersMap()HTTP headers to use for all responses from these URLs.
map<string, string> http_headers = 3;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getHttpHeadersOrDefault(String key, String defaultValue)
public String getHttpHeadersOrDefault(String key, String defaultValue)HTTP headers to use for all responses from these URLs.
map<string, string> http_headers = 3;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getHttpHeadersOrThrow(String key)
public String getHttpHeadersOrThrow(String key)HTTP headers to use for all responses from these URLs.
map<string, string> http_headers = 3;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
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.
string mime_type = 4;
| Returns | |
|---|---|
| Type | Description |
String | The mimeType. |
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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for mimeType. |
getMutableHttpHeaders()
public Map<String,String> getMutableHttpHeaders()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
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.
string path = 1;
| Returns | |
|---|---|
| Type | Description |
String | The path. |
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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for path. |
getRequireMatchingFile()
public boolean getRequireMatchingFile()Whether this handler should match the request if the file referenced by the handler does not exist.
bool require_matching_file = 6;
| Returns | |
|---|---|
| Type | Description |
boolean | The requireMatchingFile. |
getUploadPathRegex()
public String getUploadPathRegex()Regular expression that matches the file paths for all files that should be referenced by this handler.
string upload_path_regex = 2;
| Returns | |
|---|---|
| Type | Description |
String | The uploadPathRegex. |
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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for uploadPathRegex. |
hasExpiration()
public boolean hasExpiration()Time a static file served by this handler should be cached by web proxies and browsers.
.google.protobuf.Duration expiration = 5;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the expiration field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeExpiration(Duration value)
public StaticFilesHandler.Builder mergeExpiration(Duration value)Time a static file served by this handler should be cached by web proxies and browsers.
.google.protobuf.Duration expiration = 5;
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
mergeFrom(StaticFilesHandler other)
public StaticFilesHandler.Builder mergeFrom(StaticFilesHandler other)| Parameter | |
|---|---|
| Name | Description |
other | StaticFilesHandler |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StaticFilesHandler.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public StaticFilesHandler.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StaticFilesHandler.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
putAllHttpHeaders(Map<String,String> values)
public StaticFilesHandler.Builder putAllHttpHeaders(Map<String,String> values)HTTP headers to use for all responses from these URLs.
map<string, string> http_headers = 3;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
putHttpHeaders(String key, String value)
public StaticFilesHandler.Builder putHttpHeaders(String key, String value)HTTP headers to use for all responses from these URLs.
map<string, string> http_headers = 3;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
removeHttpHeaders(String key)
public StaticFilesHandler.Builder removeHttpHeaders(String key)HTTP headers to use for all responses from these URLs.
map<string, string> http_headers = 3;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
setApplicationReadable(boolean value)
public StaticFilesHandler.Builder setApplicationReadable(boolean value)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.
bool application_readable = 7;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe applicationReadable to set. |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
setExpiration(Duration value)
public StaticFilesHandler.Builder setExpiration(Duration value)Time a static file served by this handler should be cached by web proxies and browsers.
.google.protobuf.Duration expiration = 5;
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
setExpiration(Duration.Builder builderForValue)
public StaticFilesHandler.Builder setExpiration(Duration.Builder builderForValue)Time a static file served by this handler should be cached by web proxies and browsers.
.google.protobuf.Duration expiration = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public StaticFilesHandler.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
setMimeType(String value)
public StaticFilesHandler.Builder setMimeType(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe mimeType to set. |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
setMimeTypeBytes(ByteString value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for mimeType to set. |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
setPath(String value)
public StaticFilesHandler.Builder setPath(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe path to set. |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
setPathBytes(ByteString value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for path to set. |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StaticFilesHandler.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
setRequireMatchingFile(boolean value)
public StaticFilesHandler.Builder setRequireMatchingFile(boolean value)Whether this handler should match the request if the file referenced by the handler does not exist.
bool require_matching_file = 6;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe requireMatchingFile to set. |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final StaticFilesHandler.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | |
setUploadPathRegex(String value)
public StaticFilesHandler.Builder setUploadPathRegex(String value)Regular expression that matches the file paths for all files that should be referenced by this handler.
string upload_path_regex = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe uploadPathRegex to set. |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |
setUploadPathRegexBytes(ByteString value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for uploadPathRegex to set. |
| Returns | |
|---|---|
| Type | Description |
StaticFilesHandler.Builder | This builder for chaining. |