Class: Google::Apis::AppengineV1beta4::StaticDirectoryHandler

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/appengine_v1beta4/classes.rb,
generated/google/apis/appengine_v1beta4/representations.rb,
generated/google/apis/appengine_v1beta4/representations.rb

Overview

Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ StaticDirectoryHandler

Returns a new instance of StaticDirectoryHandler.


1732
1733
1734
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 1732

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#application_readableBoolean Also known as: application_readable?

Whether files should also be uploaded as code data. By default, files declared in static directory 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. Corresponds to the JSON property applicationReadable

Returns:

  • (Boolean)

1699
1700
1701
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 1699

def application_readable
  @application_readable
end

#directoryString

Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file. Corresponds to the JSON property directory

Returns:

  • (String)

1707
1708
1709
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 1707

def directory
  @directory
end

#expirationString

Time a static file served by this handler should be cached. Corresponds to the JSON property expiration

Returns:

  • (String)

1712
1713
1714
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 1712

def expiration
  @expiration
end

#http_headersHash<String,String>

HTTP headers to use for all responses from these URLs. Corresponds to the JSON property httpHeaders

Returns:

  • (Hash<String,String>)

1717
1718
1719
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 1717

def http_headers
  @http_headers
end

#mime_typeString

MIME type used to serve all files served by this handler. Defaults to file- specific MIME types, which are direved from each file's filename extension. Corresponds to the JSON property mimeType

Returns:

  • (String)

1723
1724
1725
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 1723

def mime_type
  @mime_type
end

#require_matching_fileBoolean Also known as: require_matching_file?

Whether this handler should match the request if the file referenced by the handler does not exist. Corresponds to the JSON property requireMatchingFile

Returns:

  • (Boolean)

1729
1730
1731
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 1729

def require_matching_file
  @require_matching_file
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1737
1738
1739
1740
1741
1742
1743
1744
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 1737

def update!(**args)
  @application_readable = args[:application_readable] if args.key?(:application_readable)
  @directory = args[:directory] if args.key?(:directory)
  @expiration = args[:expiration] if args.key?(:expiration)
  @http_headers = args[:http_headers] if args.key?(:http_headers)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @require_matching_file = args[:require_matching_file] if args.key?(:require_matching_file)
end