Enum gapi_grpc::google::api::backend_rule::PathTranslation

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

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

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

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>

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

Trait Implementations

impl Clone for PathTranslation

fn clone(&self) -> PathTranslation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PathTranslation

impl Debug for PathTranslation

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

Formats the value using the given formatter.

impl Default for PathTranslation

fn default() -> PathTranslation

Returns the “default value” for a type.

impl Eq for PathTranslation

impl From<PathTranslation> for i32

fn from(value: PathTranslation) -> i32

Performs the conversion.

impl Hash for PathTranslation

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

Feeds this value into the given Hasher.

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

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.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PathTranslation> for PathTranslation

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<PathTranslation> for PathTranslation

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for PathTranslation

impl StructuralPartialEq for PathTranslation