# App Engine Admin V1 API - Class Google::Cloud::AppEngine::V1::UrlMap (v1.8.0)

1.8.0 (latest) 1.7.0 1.6.0 1.5.1 1.4.0 1.3.0 1.2.1 1.1.0 1.0.1 0.10.0 0.9.2 0.8.0 0.7.0 0.6.1 0.5.0 0.4.0 0.3.6 Reference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::UrlMap.

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.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #api_endpoint

    def api_endpoint() -> ::Google::Cloud::AppEngine::V1::ApiEndpointHandler

**Returns**

- ([::Google::Cloud::AppEngine::V1::ApiEndpointHandler](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-ApiEndpointHandler)) --- Uses API Endpoints to handle requests.


  Note: The following fields are mutually exclusive: `api_endpoint`, `static_files`, `script`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #api_endpoint=

    def api_endpoint=(value) -> ::Google::Cloud::AppEngine::V1::ApiEndpointHandler

**Parameter**

- **value** ([::Google::Cloud::AppEngine::V1::ApiEndpointHandler](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-ApiEndpointHandler)) --- Uses API Endpoints to handle requests.


  Note: The following fields are mutually exclusive: `api_endpoint`, `static_files`, `script`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::AppEngine::V1::ApiEndpointHandler](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-ApiEndpointHandler)) --- Uses API Endpoints to handle requests.


  Note: The following fields are mutually exclusive: `api_endpoint`, `static_files`, `script`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #auth_fail_action

    def auth_fail_action() -> ::Google::Cloud::AppEngine::V1::AuthFailAction

**Returns**

- ([::Google::Cloud::AppEngine::V1::AuthFailAction](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-AuthFailAction)) --- Action to take when users access resources that require authentication. Defaults to `redirect`.

### #auth_fail_action=

    def auth_fail_action=(value) -> ::Google::Cloud::AppEngine::V1::AuthFailAction

**Parameter**

- **value** ([::Google::Cloud::AppEngine::V1::AuthFailAction](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-AuthFailAction)) --- Action to take when users access resources that require authentication. Defaults to `redirect`.
**Returns**

- ([::Google::Cloud::AppEngine::V1::AuthFailAction](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-AuthFailAction)) --- Action to take when users access resources that require authentication. Defaults to `redirect`.

### #login

    def login() -> ::Google::Cloud::AppEngine::V1::LoginRequirement

**Returns**

- ([::Google::Cloud::AppEngine::V1::LoginRequirement](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-LoginRequirement)) --- Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.

### #login=

    def login=(value) -> ::Google::Cloud::AppEngine::V1::LoginRequirement

**Parameter**

- **value** ([::Google::Cloud::AppEngine::V1::LoginRequirement](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-LoginRequirement)) --- Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
**Returns**

- ([::Google::Cloud::AppEngine::V1::LoginRequirement](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-LoginRequirement)) --- Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.

### #redirect_http_response_code

    def redirect_http_response_code() -> ::Google::Cloud::AppEngine::V1::UrlMap::RedirectHttpResponseCode

**Returns**

- ([::Google::Cloud::AppEngine::V1::UrlMap::RedirectHttpResponseCode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-UrlMap-RedirectHttpResponseCode)) --- `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.

### #redirect_http_response_code=

    def redirect_http_response_code=(value) -> ::Google::Cloud::AppEngine::V1::UrlMap::RedirectHttpResponseCode

**Parameter**

- **value** ([::Google::Cloud::AppEngine::V1::UrlMap::RedirectHttpResponseCode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-UrlMap-RedirectHttpResponseCode)) --- `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
**Returns**

- ([::Google::Cloud::AppEngine::V1::UrlMap::RedirectHttpResponseCode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-UrlMap-RedirectHttpResponseCode)) --- `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.

### #script

    def script() -> ::Google::Cloud::AppEngine::V1::ScriptHandler

**Returns**

- ([::Google::Cloud::AppEngine::V1::ScriptHandler](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-ScriptHandler)) --- Executes a script to handle the requests that match this URL pattern. Only the `auto` value is supported for Node.js in the App Engine standard environment, for example `"script": "auto"`.


  Note: The following fields are mutually exclusive: `script`, `static_files`, `api_endpoint`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #script=

    def script=(value) -> ::Google::Cloud::AppEngine::V1::ScriptHandler

**Parameter**

- **value** ([::Google::Cloud::AppEngine::V1::ScriptHandler](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-ScriptHandler)) --- Executes a script to handle the requests that match this URL pattern. Only the `auto` value is supported for Node.js in the App Engine standard environment, for example `"script": "auto"`.


  Note: The following fields are mutually exclusive: `script`, `static_files`, `api_endpoint`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::AppEngine::V1::ScriptHandler](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-ScriptHandler)) --- Executes a script to handle the requests that match this URL pattern. Only the `auto` value is supported for Node.js in the App Engine standard environment, for example `"script": "auto"`.


  Note: The following fields are mutually exclusive: `script`, `static_files`, `api_endpoint`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #security_level

    def security_level() -> ::Google::Cloud::AppEngine::V1::SecurityLevel

**Returns**

- ([::Google::Cloud::AppEngine::V1::SecurityLevel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-SecurityLevel)) --- Security (HTTPS) enforcement for this URL.

### #security_level=

    def security_level=(value) -> ::Google::Cloud::AppEngine::V1::SecurityLevel

**Parameter**

- **value** ([::Google::Cloud::AppEngine::V1::SecurityLevel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-SecurityLevel)) --- Security (HTTPS) enforcement for this URL.
**Returns**

- ([::Google::Cloud::AppEngine::V1::SecurityLevel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-SecurityLevel)) --- Security (HTTPS) enforcement for this URL.

### #static_files

    def static_files() -> ::Google::Cloud::AppEngine::V1::StaticFilesHandler

**Returns**

- ([::Google::Cloud::AppEngine::V1::StaticFilesHandler](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-StaticFilesHandler)) --- Returns the contents of a file, such as an image, as the response.


  Note: The following fields are mutually exclusive: `static_files`, `script`, `api_endpoint`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #static_files=

    def static_files=(value) -> ::Google::Cloud::AppEngine::V1::StaticFilesHandler

**Parameter**

- **value** ([::Google::Cloud::AppEngine::V1::StaticFilesHandler](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-StaticFilesHandler)) --- Returns the contents of a file, such as an image, as the response.


  Note: The following fields are mutually exclusive: `static_files`, `script`, `api_endpoint`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::AppEngine::V1::StaticFilesHandler](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-StaticFilesHandler)) --- Returns the contents of a file, such as an image, as the response.


  Note: The following fields are mutually exclusive: `static_files`, `script`, `api_endpoint`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #url_regex

    def url_regex() -> ::String

**Returns**

- (::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.

### #url_regex=

    def url_regex=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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.