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



2541
2542
2543
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2541

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:



2497
2498
2499
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2497

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) 


2503
2504
2505
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2503

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) 


2508
2509
2510
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2508

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) 


2514
2515
2516
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2514

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:



2519
2520
2521
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2519

def script
  @script
end

#security_level ⇒ String

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

Returns:

  • (String) 


2524
2525
2526
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2524

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:



2531
2532
2533
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2531

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) 


2539
2540
2541
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2539

def url_regex
  @url_regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2546

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