public enum BackendRule.PathTranslation extends Enum<BackendRule.PathTranslation> implements ProtocolMessageEnum
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 enum google.api.BackendRule.PathTranslation
Implements
ProtocolMessageEnumStatic Fields
Name | Description |
APPEND_PATH_TO_ADDRESS | The request path will be appended to the backend address. ExamplesGiven 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 |
APPEND_PATH_TO_ADDRESS_VALUE | The request path will be appended to the backend address. ExamplesGiven 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 |
CONSTANT_ADDRESS | 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. ExamplesGiven 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 |
CONSTANT_ADDRESS_VALUE | 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. ExamplesGiven 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 |
PATH_TRANSLATION_UNSPECIFIED |
|
PATH_TRANSLATION_UNSPECIFIED_VALUE |
|
UNRECOGNIZED |
Static Methods
Name | Description |
forNumber(int value) | |
getDescriptor() | |
internalGetValueMap() | |
valueOf(Descriptors.EnumValueDescriptor desc) | |
valueOf(int value) | Deprecated. Use #forNumber(int) instead. |
valueOf(String name) | |
values() |
Methods
Name | Description |
getDescriptorForType() | |
getNumber() | |
getValueDescriptor() |