Enum BackendRule.Types.PathTranslation (2.17.0)
public enum BackendRule.Types.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.
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Fields
|
Name |
Description |
AppendPathToAddress |
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
|
ConstantAddress |
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
|
Unspecified |
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-10 UTC."],[],[]]