Class: Google::Apis::AppengineV1beta4::StaticFilesHandler

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
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 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::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ StaticFilesHandler

Returns a new instance of StaticFilesHandler.


789
790
791
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 789

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

Instance Attribute Details

#application_readableBoolean Also known as: application_readable?

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 an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas. Corresponds to the JSON property applicationReadable

Returns:

  • (Boolean)

786
787
788
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 786

def application_readable
  @application_readable
end

#expirationString

The length of time a static file served by this handler ought to be cached by web proxies and browsers. Corresponds to the JSON property expiration

Returns:

  • (String)

769
770
771
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 769

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

756
757
758
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 756

def http_headers
  @http_headers
end

#mime_typeString

If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension. Corresponds to the JSON property mimeType

Returns:

  • (String)

763
764
765
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 763

def mime_type
  @mime_type
end

#pathString

The 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)

745
746
747
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 745

def path
  @path
end

#require_matching_fileBoolean Also known as: require_matching_file?

If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL. Corresponds to the JSON property requireMatchingFile

Returns:

  • (Boolean)

776
777
778
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 776

def require_matching_file
  @require_matching_file
end

#upload_path_regexString

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

Returns:

  • (String)

751
752
753
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 751

def upload_path_regex
  @upload_path_regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


794
795
796
797
798
799
800
801
802
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 794

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