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.

Protobuf type google.api.BackendRule.PathTranslation

CloneableInstantiable
Constants
public Google\Api\BackendRule\PathTranslation::APPEND_PATH_TO_ADDRESS = 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

Generated from protobuf enum APPEND_PATH_TO_ADDRESS = 2;

public Google\Api\BackendRule\PathTranslation::CONSTANT_ADDRESS = 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

Generated from protobuf enum CONSTANT_ADDRESS = 1;

public Google\Api\BackendRule\PathTranslation::PATH_TRANSLATION_UNSPECIFIED = 0
 
Generated from protobuf enum PATH_TRANSLATION_UNSPECIFIED = 0;

Methods
public static name( $value)
public static value( $name)
Properties
private static $valueToName
Properties
private static $valueToName
Methods
public static name( $value)
public static value( $name)
© 2020 Bruce Wells
Search Namespaces \ Classes
ConfigurationNumbers (0-9.) only