Class: Google::Apis::AppengineV1beta5::StaticFilesHandler

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/appengine_v1beta5/classes.rb,
generated/google/apis/appengine_v1beta5/representations.rb,
generated/google/apis/appengine_v1beta5/representations.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.

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) ⇒ StaticFilesHandler

Returns a new instance of StaticFilesHandler



1648
1649
1650
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1648

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

Instance Attribute Details

#application_readable ⇒ Boolean Also known as: application_readable?

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. Corresponds to the JSON property applicationReadable

Returns:

  • (Boolean) 


1610
1611
1612
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1610

def application_readable
  @application_readable
end

#expiration ⇒ String

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

Returns:

  • (String) 


1616
1617
1618
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1616

def expiration
  @expiration
end

#http_headers ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


1621
1622
1623
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1621

def http_headers
  @http_headers
end

#mime_type ⇒ 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. Corresponds to the JSON property mimeType

Returns:

  • (String) 


1627
1628
1629
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1627

def mime_type
  @mime_type
end

#path ⇒ 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. Corresponds to the JSON property path

Returns:

  • (String) 


1633
1634
1635
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1633

def path
  @path
end

#require_matching_file ⇒ Boolean 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) 


1639
1640
1641
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1639

def require_matching_file
  @require_matching_file
end

#upload_path_regex ⇒ String

Regular expression that matches the file paths for all files that should be referenced by this handler. Corresponds to the JSON property uploadPathRegex

Returns:

  • (String) 


1646
1647
1648
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1646

def upload_path_regex
  @upload_path_regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1653
1654
1655
1656
1657
1658
1659
1660
1661
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1653

def update!(**args)
  @application_readable = args[:application_readable] if args.key?(:application_readable)
  @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)
  @path = args[:path] if args.key?(:path)
  @require_matching_file = args[:require_matching_file] if args.key?(:require_matching_file)
  @upload_path_regex = args[:upload_path_regex] if args.key?(:upload_path_regex)
end