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
Self type

Members list

Concise view

Type members

Classlikes

The request path will be appended to the backend address.

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
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type

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.

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
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type

Attributes

Source:
BackendRule.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
sealed trait Recognized extends PathTranslation

Attributes

Source:
BackendRule.scala
Graph
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
final case class Unrecognized(unrecognizedValue: Int) extends PathTranslation with UnrecognizedEnum

Attributes

Source:
BackendRule.scala
Graph
Supertypes
trait UnrecognizedEnum
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
Source:
Mirror.scala

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source:
Mirror.scala
type ValueType = A

Attributes

Inherited from:
GeneratedEnumCompanion
Source:
GeneratedMessageCompanion.scala

Value members

Concrete methods

def fromValue(`__value`: Int): PathTranslation

Attributes

Source:
BackendRule.scala
def javaDescriptor: EnumDescriptor

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.

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.

Attributes

Source:
BackendRule.scala
def scalaDescriptor: EnumDescriptor

Attributes

Source:
BackendRule.scala

Inherited methods

def fromName(name: String): Option[A]

Attributes

Inherited from:
GeneratedEnumCompanion
Source:
GeneratedMessageCompanion.scala

Concrete fields

Attributes

Source:
BackendRule.scala

Implicits

Implicits

implicit def enumCompanion: GeneratedEnumCompanion[PathTranslation]

Attributes

Source:
BackendRule.scala