Enum PathTranslation 

#[non_exhaustive]
pub enum PathTranslation {
    Unspecified,
    ConstantAddress,
    AppendPathToAddress,
    UnknownValue(UnknownValue),
}

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.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

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

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

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using PathTranslation::value or PathTranslation::name.

Implementations

impl PathTranslation

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for PathTranslation

fn clone(&self) -> PathTranslation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PathTranslation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PathTranslation

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PathTranslation

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PathTranslation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<&str> for PathTranslation

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for PathTranslation

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for PathTranslation

fn eq(&self, other: &PathTranslation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PathTranslation

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PathTranslation