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

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

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ StaticDirectoryHandler

Returns a new instance of StaticDirectoryHandler.


854
855
856
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 854

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)

851
852
853
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 851

def application_readable
  @application_readable
end

#directoryString

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

816
817
818
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 816

def directory
  @directory
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)

834
835
836
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 834

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

821
822
823
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 821

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)

828
829
830
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 828

def mime_type
  @mime_type
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)

841
842
843
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 841

def require_matching_file
  @require_matching_file
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


859
860
861
862
863
864
865
866
# File 'generated/google/apis/appengine_v1beta4/classes.rb', line 859

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