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

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

Constructor Details

#initialize(**args) ⇒ UrlMap

Returns a new instance of UrlMap.



2922
2923
2924
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2922

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:



2877
2878
2879
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2877

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) 


2883
2884
2885
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2883

def auth_fail_action
  @auth_fail_action
end

#login ⇒ String

Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. Corresponds to the JSON property login

Returns:

  • (String) 


2889
2890
2891
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2889

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) 


2895
2896
2897
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2895

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:



2900
2901
2902
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2900

def script
  @script
end

#security_level ⇒ String

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

Returns:

  • (String) 


2905
2906
2907
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2905

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:



2912
2913
2914
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2912

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) 


2920
2921
2922
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2920

def url_regex
  @url_regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
 
# File 'lib/google/apis/appengine_v1/classes.rb', line 2927

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