Enum PathTranslation

#[repr(i32)]
pub enum PathTranslation {
    Unspecified = 0,
    ConstantAddress = 1,
    AppendPathToAddress = 2,
}

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.

Variants

Unspecified = 0

ConstantAddress = 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>

AppendPathToAddress = 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>

Implementations

impl PathTranslation

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of PathTranslation.

pub fn from_i32(value: i32) -> Option<PathTranslation>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a PathTranslation, or None if value is not a valid variant.

impl PathTranslation

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<PathTranslation>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for PathTranslation

fn clone(&self) -> PathTranslation

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for PathTranslation

fn default() -> PathTranslation

Returns the “default value” for a type.

impl Hash for PathTranslation

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PathTranslation

fn cmp(&self, other: &PathTranslation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for PathTranslation

fn partial_cmp(&self, other: &PathTranslation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for PathTranslation

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<PathTranslation, UnknownEnumValue>

Performs the conversion.

impl Copy for PathTranslation

impl Eq for PathTranslation

impl StructuralPartialEq for PathTranslation