http4s-grpc-google-common-protos/com.google/com.google.api/com.google.api.backend/BackendRule/PathTranslation

PathTranslation

com.google.api.backend.BackendRule.PathTranslation

See thePathTranslation companion class

object PathTranslation extends GeneratedEnumCompanion[PathTranslation]

Attributes

Companion: class
Source: BackendRule.scala
Graph
Supertypes: trait Sum

trait Mirror

trait GeneratedEnumCompanion[PathTranslation]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: PathTranslation.type

Members list

Type members

Classlikes

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

Attributes

Source: BackendRule.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class PathTranslation

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: APPEND_PATH_TO_ADDRESS.type

Use the backend address as-is, with no modification to the path.

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

Attributes

Source: BackendRule.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class PathTranslation

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: CONSTANT_ADDRESS.type

Attributes

Source: BackendRule.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class PathTranslation

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: PATH_TRANSLATION_UNSPECIFIED.type

Attributes

Source: BackendRule.scala
Supertypes: class PathTranslation

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: object APPEND_PATH_TO_ADDRESS.type

object CONSTANT_ADDRESS.type

object PATH_TRANSLATION_UNSPECIFIED.type

Attributes

Source: BackendRule.scala
Supertypes: trait UnrecognizedEnum

class PathTranslation

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Inherited types

The names of the product elements

Attributes

Inherited from:: Mirror
Source: Mirror.scala

The name of the type

Attributes

Inherited from:: Mirror
Source: Mirror.scala

Attributes

Inherited from:: GeneratedEnumCompanion
Source: GeneratedMessageCompanion.scala

Value members

Concrete methods

Attributes

Source: BackendRule.scala

Returns the Java descriptors for this enum.

Returns the Java descriptors for this enum. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.