Service Management V1 API - Module Google::Api::BackendRule::PathTranslation (v0.3.10)

Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the Service Management V1 API module Google::Api::BackendRule::PathTranslation.

Path Translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request.

Path Translation is applicable only to HTTP-based backends. Backends which do not accept requests over HTTP/HTTPS should leave path_translation unspecified.

Constants

PATH_TRANSLATION_UNSPECIFIED

value: 0

CONSTANT_ADDRESS

value: 1

Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string.

Examples

Given the following operation config:

Method path:        /api/company/{cid}/user/{uid}
Backend address:    https://example.cloudfunctions.net/getUser

Requests to the following request paths will call the backend at the translated path:

Request path: /api/company/widgetworks/user/johndoe
Translated:
https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe

Request path: /api/company/widgetworks/user/johndoe?timezone=EST
Translated:
https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe

APPEND_PATH_TO_ADDRESS

value: 2

The request path will be appended to the backend address.

Examples

Given the following operation config:

Method path:        /api/company/{cid}/user/{uid}
Backend address:    https://example.appspot.com

Requests to the following request paths will call the backend at the translated path:

Request path: /api/company/widgetworks/user/johndoe
Translated:
https://example.appspot.com/api/company/widgetworks/user/johndoe

Request path: /api/company/widgetworks/user/johndoe?timezone=EST
Translated:
https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST