Class: Google::Apis::AppengineV1::UrlMap

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

Overview

URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.

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

Returns a new instance of UrlMap



1816
1817
1818
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1816

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

Instance Attribute Details

#api_endpoint ⇒ Google::Apis::AppengineV1::ApiEndpointHandler

Uses Google Cloud Endpoints to handle requests. Corresponds to the JSON property apiEndpoint

Returns:



1814
1815
1816
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1814

def api_endpoint
  @api_endpoint
end

#auth_fail_action ⇒ String

Action to take when users access resources that require authentication. Defaults to redirect. Corresponds to the JSON property authFailAction

Returns:

  • (String) 


1791
1792
1793
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1791

def auth_fail_action
  @auth_fail_action
end

#login ⇒ String

Level of login required to access this resource. Corresponds to the JSON property login

Returns:

  • (String) 


1809
1810
1811
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1809

def 
  @login
end

#redirect_http_response_code ⇒ String

30x code to use when performing redirects for the secure field. Defaults to 302. Corresponds to the JSON property redirectHttpResponseCode

Returns:

  • (String) 


1780
1781
1782
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1780

def redirect_http_response_code
  @redirect_http_response_code
end

#script ⇒ Google::Apis::AppengineV1::ScriptHandler

Executes a script to handle the request that matches the URL pattern. Corresponds to the JSON property script

Returns:



1796
1797
1798
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1796

def script
  @script
end

#security_level ⇒ String

Security (HTTPS) enforcement for this URL. Corresponds to the JSON property securityLevel

Returns:

  • (String) 


1785
1786
1787
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1785

def security_level
  @security_level
end

#static_files ⇒ Google::Apis::AppengineV1::StaticFilesHandler

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

Returns:



1774
1775
1776
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1774

def static_files
  @static_files
end

#url_regex ⇒ String

URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. Corresponds to the JSON property urlRegex

Returns:

  • (String) 


1804
1805
1806
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1804

def url_regex
  @url_regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1821

def update!(**args)
  @static_files = args[:static_files] if args.key?(:static_files)
  @redirect_http_response_code = args[:redirect_http_response_code] if args.key?(:redirect_http_response_code)
  @security_level = args[:security_level] if args.key?(:security_level)
  @auth_fail_action = args[:auth_fail_action] if args.key?(:auth_fail_action)
  @script = args[:script] if args.key?(:script)
  @url_regex = args[:url_regex] if args.key?(:url_regex)
  @login = args[:login] if args.key?(:login)
  @api_endpoint = args[:api_endpoint] if args.key?(:api_endpoint)
end