Class: Google::Cloud::AppEngine::V1::StaticFilesHandler

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/appengine/v1/app_yaml.rb

Overview

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.

Defined Under Namespace

Classes: HttpHeadersEntry

Instance Attribute Summary collapse

Instance Attribute Details

#application_readable ⇒ ::Boolean

Returns 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:

  • (::Boolean) —

    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.



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 177

class StaticFilesHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class HttpHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#expiration ⇒ ::Google::Protobuf::Duration

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

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 177

class StaticFilesHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class HttpHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#http_headers ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns HTTP headers to use for all responses from these URLs.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    HTTP headers to use for all responses from these URLs.



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 177

class StaticFilesHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class HttpHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#mime_type ⇒ ::String

Returns 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:

  • (::String) —

    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.



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 177

class StaticFilesHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class HttpHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#path ⇒ ::String

Returns 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:

  • (::String) —

    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.



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 177

class StaticFilesHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class HttpHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#require_matching_file ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 177

class StaticFilesHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class HttpHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#upload_path_regex ⇒ ::String

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

Returns:

  • (::String) —

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



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 177

class StaticFilesHandler
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class HttpHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end