Interface StaticFilesHandlerOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    StaticFilesHandler, StaticFilesHandler.Builder

    public interface StaticFilesHandlerOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsHttpHeaders​(String key)
      HTTP headers to use for all responses from these URLs.
      boolean getApplicationReadable()
      Whether files should also be uploaded as code data.
      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.
      Map<String,​String> getHttpHeaders()
      Deprecated.
      int getHttpHeadersCount()
      HTTP headers to use for all responses from these URLs.
      Map<String,​String> getHttpHeadersMap()
      HTTP headers to use for all responses from these URLs.
      String getHttpHeadersOrDefault​(String key, String defaultValue)
      HTTP headers to use for all responses from these URLs.
      String getHttpHeadersOrThrow​(String key)
      HTTP headers to use for all responses from these URLs.
      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.
      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.
      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.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getPath

        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:
        The path.
      • getPathBytes

        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.
         
        string path = 1;
        Returns:
        The bytes for path.
      • getUploadPathRegex

        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:
        The uploadPathRegex.
      • getUploadPathRegexBytes

        com.google.protobuf.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:
        The bytes for uploadPathRegex.
      • getHttpHeadersCount

        int getHttpHeadersCount()
         HTTP headers to use for all responses from these URLs.
         
        map<string, string> http_headers = 3;
      • containsHttpHeaders

        boolean containsHttpHeaders​(String key)
         HTTP headers to use for all responses from these URLs.
         
        map<string, string> http_headers = 3;
      • getHttpHeadersMap

        Map<String,​String> getHttpHeadersMap()
         HTTP headers to use for all responses from these URLs.
         
        map<string, string> http_headers = 3;
      • getHttpHeadersOrDefault

        String getHttpHeadersOrDefault​(String key,
                                       String defaultValue)
         HTTP headers to use for all responses from these URLs.
         
        map<string, string> http_headers = 3;
      • getHttpHeadersOrThrow

        String getHttpHeadersOrThrow​(String key)
         HTTP headers to use for all responses from these URLs.
         
        map<string, string> http_headers = 3;
      • getMimeType

        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:
        The mimeType.
      • getMimeTypeBytes

        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.
         
        string mime_type = 4;
        Returns:
        The bytes for mimeType.
      • hasExpiration

        boolean hasExpiration()
         Time a static file served by this handler should be cached
         by web proxies and browsers.
         
        .google.protobuf.Duration expiration = 5;
        Returns:
        Whether the expiration field is set.
      • getExpiration

        com.google.protobuf.Duration getExpiration()
         Time a static file served by this handler should be cached
         by web proxies and browsers.
         
        .google.protobuf.Duration expiration = 5;
        Returns:
        The expiration.
      • getExpirationOrBuilder

        com.google.protobuf.DurationOrBuilder getExpirationOrBuilder()
         Time a static file served by this handler should be cached
         by web proxies and browsers.
         
        .google.protobuf.Duration expiration = 5;
      • getRequireMatchingFile

        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:
        The requireMatchingFile.
      • getApplicationReadable

        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:
        The applicationReadable.